Latest Version of OpenEMM 19.04: Backend: 19.04.000.441, Frontend: 19.04.000.488
Latest Version of OpenEMM 19.10: Backend: 19.10.000.128, Frontend: 19.10.000.170
Latest Version of OpenEMM 20.04: Backend: 20.04.000.190, Frontend: 20.04.000.188
Utility Package for OpenEMM Deployment & Runtime: 20.04.000.043
(as of September 10, 2020)
This wiki provides the brief version of the extensive OpenEMM Installation & Administration Guide 1.2.0 (including SLES instructions) for OpenEMM 19.x.
The lastest runtime version offers you to upgrade to OpenEMM 20.04 BETA. Because several things have changed in OpenEMM version 20.04, we created a new Installation & Administration Guide for OpenEMM 2020. For OpenEMM 20.x, use that PDF guide instead of this wiki.
We kindly ask you to contribute your feedback and questions to improve the documentation, installation, configuration and administration of OpenEMM! Please leave your questions and comments in the OpenEMM forum at forum.openemm.org.
OpenEMM is a professional open source software for email marketing and automation. If you want to automate your email communication, OpenEMM is the right choice for you.
The first version of OpenEMM was published in 2006. The source code of the frontend and the backend of OpenEMM 19.04 and later is available at GitHub. It uses the popular open source license AGLPv3. At the end of this page you can find instructions on how to build OpenEMM by yourself.
If you want to install or upgrade to OpenEMM 20.04, please use the PDF guide mentioned above.
OpenEMM consists of 2 packages:
We also offer a utility package for easy deployment and operations of the binary code of OpenEMM: openemm-runtime-19.*.tar.gz
Unless noted otherwise below, use user “root”.
The following instructions in this chapter are targeted at RedHat 7 or CentOS 7. Beginning with OpenEMM 19.10, linux distribution SLES 15 is supported as well. In this case, please follow the instructions here.
Install the required packages:
# yum install gcc # yum install python # yum install java-1.8.0-openjdk-devel # yum install xorg-x11-fonts-75dpi zlib fontconfig freetype libX11 libXext libXrender urw-fonts
Depending on the DBMS you want to use, either install MariaDB or MySQL.
MariaDB and MySQL code repository for RedHat7:
# subscription-manager repos –enable rhel-server-rhscl-7-rpms
MariaDB and MySQL code repository for CentOS7:
# yum install centos-release-scl
Tip: After installation of either MariaDB or MySQL, you should consider running script mysql_secure_installation to set a password for user root, to remove any anonymous users and to disallow remote logins.
This example uses MariaDB 10.2:
# yum install rh-mariadb102-mariadb-server # yum install MySQL-python
Make sure MariaDB is running and re-started at every server reboot:
# systemctl enable rh-mariadb102-mariadb # systemctl start rh-mariadb102-mariadb
Finally, set a symlink to make sure that OpenEMM can find MariaDB:
# cd /bin # ln -s /opt/rh/rh-mariadb102/root/bin/* .
This example uses MySQL 5.7:
# yum install rh-mysql57-mysql-server # yum install MySQL-python
Make sure MySQL is running and re-started at every server reboot:
# systemctl enable rh-mysql57-mysql # systemctl start rh-mysql57-mysql
Finally, set a symlink to make sure that OpenEMM can find MySQL:
# cd /bin # ln -s /opt/rh/rh-mysql57/root/bin/* .
Depending on the MTA you want to use, either install Sendmail or Postfix.
If you want to use Sendmail as SMTP server (MTA), you have to stop and remove Postfix first (in case it is installed), and you have to install the required packages for Sendmail.
# systemctl stop postfix # yum remove postfix # yum install sendmail sendmail-cf sendmail-milter procmail
After that, if necessary, switch the default SMTP server to Sendmail with
# alternatives --set mta /usr/sbin/sendmail.sendmail
and change Sendmail's configuration: Open file sendmail.mc in directory /etc/mail and add a leading “dnl ” to line
This will enable Sendmail to listen on all available network interfaces and allows the processing of asynchronous bounces and auto responder mails. By default, Sendmail listens only on the local interface for connections, but dnl comments out this directive.
Additionally, add line
INPUT_MAIL_FILTER(`bav', `S=unix:/home/openemm/var/run/bav.sock, F=T')dnl
at the end of file sendmail.mc to make Sendmail familiar with OpenEMM's mail filter BAV (bounce address validator) so that the bounce management can process asynchronous bounces, too.
The mailloop service of OpenEMM, which processes the asynchronous bounces and auto responder mails needs some more preparations:
# cd /etc/mail # umask 022 # [ -f relay-domains ] || touch relay-domains # [ -f mailertable ] || touch mailertable
To activate your changes to the Sendmail configuration you have to compile the intermediate file sendmail.mc to the final configuration file sendmail.cf and activate the new configuration with
# cd /etc/mail # make # systemctl restart sendmail
If you want to use Postfix as SMTP server (MTA), you have to stop and remove Sendmail first (in case it is installed), and you have to install the required packages for Postfix.
# systemctl stop sendmail # yum remove sendmail # yum install postfix sendmail-milter procmail
After that, switch the default SMTP server to Postfix with
# alternatives --set mta /usr/sbin/sendmail.postfix
and change Postfix' configuration to unleash all features. To do this, change to the Postfix main configuration directory:
# cd /etc/postfix
and add some configuration parameters to Postfix' main configuration file main.cf:
inet_interfaces = all inet_protocols = all mailbox_command = /usr/bin/procmail mailbox_size_limit = 0 message_size_limit = 0 maximal_queue_lifetime = 1d bounce_queue_lifetime = 1d smtp_tls_security_level = may smtp_tls_protocols = !SSLv2, !SSLv3 smtp_tls_ciphers = high smtp_tls_mandatory_ciphers = $smtp_tls_ciphers hash_queue_depth = 2 enable_long_queue_ids = yes relay_domains = /home/openemm/var/run/relay.domains transport_maps = hash:/home/openemm/var/run/transport.maps smtpd_milters = unix:/home/openemm/var/run/bav.sock
If lines with parameters of the same name already exist in file main.cf, comment them with character # at the beginning to avoid any warning messages or overwrite them with the new values in case you do not want to keep the original values as backup.
Additionally, you have to set parameter myhostname in file main.cf to the FQDN of your OpenEMM server. Otherwise, mails would be sent with sender domain localhost.localdomain instead.
Finally, add these lines to configuration file master.cf:
mailloop unix - n n - - pipe flags=RX user=openemm argv=/usr/bin/procmail /home/openemm/lib/bav.rc
Please do not omit the two space characters before keyword “flags” to indicate the parser that the line is continued!
Last not least, activate the TLS manager in file master.cf by uncommenting (i.e. removing the leading #) line
tlsmgr unix - - n 1000? 1 tlsmgr
to permit sending of TLS encrypted emails.
To activate your changes, restart Postfix with
# systemctl restart postfix
Download the RPM of “wkhtmltox” from wkhtmltopdf.org and unpack it:
# rpm -ihv wkhtmltox-*.rpm
Open port 25 and port 8080 in the firewall and add a port forwarding from port 80 to 8080, so you do not have to enter the URL of your OpenEMM server with “:8080” at the end:
# firewall-cmd --get-active-zones
If your zone is “public” (if not, use the zone name you got with the aforementioned statement):
# firewall-cmd --zone=public --add-port=8080/tcp --permanent # firewall-cmd --zone=public --add-port=25/tcp --permanent # firewall-cmd --zone=public --add-forward-port=port=80:proto=tcp:toport=8080 --permanent # firewall-cmd --reload
Create group and user for OpenEMM:
# groupadd openemm # useradd -m -g openemm -d /home/openemm -s /bin/bash openemm # passwd openemm # su - openemm
We recommend to download the latest deployment & runtime package of OpenEMM from here. This package provides the installer for the backend and frontend code. Of course, you can also take the source code of OpenEMM from GitHub and compile and deploy the software manually yourself. See the instructions at the end of this page.
Download runtime tarball (file name: openemm-runtime-19.*.tar.gz) to /home/openemm to create the deployment and runtime environment for OpenEMM.
Change to user openemm, unpack and start it with
# su - openemm $ tar -xvzpf openemm-runtime-19.*.tar.gz $ ./OpenEMMInstaller.sh
Due to bug in Runtime versions before 19.07.015 a symlink was missing after instalation (it is only created after the first update of the runtime package). Create this symlink with
$ ln -s /home/openemm/tomcat/bin/openemm.sh /home/openemm/bin/openemm.sh
This symlink makes sure that the backend is restarted, too, when restarting OpenEMM.
At launch time OpenEMMInstaller checks your environment and offers to install required packages (including Tomcat 9), to configure a database connection (file dbcfg) and to set environment variables
The parameters will be written to file setenv.sh in directory /home/openemm/bin/.
OpenEMMInstaller also checks if kernel parameter in /etc/security/limits.conf are sufficient and, if not, offers to change them. However, you have to restart OpenEMMInstaller as user root to be able to change the file:
$ sudo su - # /home/openemm/bin/OpenEMMInstaller.sh
If database configuration file dbcfg does not exist in directory /home/openemm/etc/, OpenEMMInstaller asks for the required parameters like database type (“mysql” or “mariadb”), database name (“openemm”), database user (“openemm”) and your database password.
For the deployment of the backend tarball you have to run OpenEMMInstaller as user root, because some files of the tarball have to be deployed with root permissions:
$ sudo su - # /home/openemm/bin/OpenEMMInstaller.sh
Use menu “Install or update package from AGNITAS website” to install the frontend and backend package. The same menu also offers to install Tomcat or an update of the runtime package, but you can select “n” for any package, if you do not want to install or update it.
During Deployment of the backend tarball several new directories and symlinks will be created in /home/openemm/.
If you do not want to install the backend package of OpenEMM, you can start OpenEMMInstaller as user “openemm”:
# su - openemm $ OpenEMMInstaller.sh
When the frontend is installed, the OpenEMM database is automatically filled with its initial content.
OpenEMM requires read access to the mail log file at /var/log/maillog and logrotate has to be aware of this fact, too. Open file /etc/logrotate.d/syslog and add the following line after the line sharedscripts:
# create 0644
# chmod 644 /var/log/maillog
to set the permissions of the current maillog.
Use menu “Configuration and “Security” of OpenEMMInstaller to set up and change the configuration of OpenEMM.
Set various essential parameters in sub-menu “Change emm.properties” of menu “Configuration”:
Use menu “Configuration”, sub-menu “Change client/account data in db” to set important values in the OpenEMM database:
Finally, create an initial password for main user “emm-master” in menu “Security”. Write down the generated password and use user “emm-master” and this initial password later for your first login. At first login, you will be prompted to change your password to a new one of your choice.
Launch OpenEMM with menu “Restart OpenEMM”. Experts may have a look at the Tomcat log during startup with
$ tail -f logs/catalina.out
to check for any warnings or error messages.
Point your browser to your OpenEMM server and log in with user “emm-master” and the password you just created. OpenEMM will ask you to change the initial password to a new one of your choice.
If you want to install the context-sensitive help feature of OpenEMM, download it via OpenEMMInstaller menu “Install or update package from AGNITAS Website” (not available, yet).
You do not have to start from scratch when producing mailings and creating forms in OpenEMM. At https://www.agnitas.de/en/download-center/ you can download templates and forms which you can import into OpenEMM. Make sure to replace all placeholders for a company ID with value “1”.
The mailloop service of OpenEMM pocesses asynchronous bounces, i.e. bounces that are not sent back instantly by the receiving MTA, but only after a delay. There are several options to configure the mailloop service. See section OpenEMM Mailloop Configuration for details.
The top of this Wiki lists the latest available versions of OpenEMM backend, frontend and the deployment & runtime package.
You can download the latest versions of packages with menu “Install or update package from AGNITAS Website” of OpenEMMInstaller. An update of the frontend package will also update the schema of the OpenEMM database, if necessary. Please keep in mind that you have to start OpenEMMInstaller as user root, if you want to update the backend, too.
If you use runtime version 20.04.000.001 or later, you are offered to upgrade to new release OpenEMM 20.04. If you are not happy with the new release (or any other version of OpenEMM), you can roll back OpenEMM to an earlier (or later) version with menu “Switch OpenEMM version”.
Do not forget to restart OpenEMM with menu “Restart OpenEMM” after you have downloaded and installed an update package to activate it. But do the restart at an convenient time: Do not restart OpenEMM during a dispatch of a mailing, or right after the dispatch (due to the brief downtime of the redirect service causing missed openings and click redirects).
The beta PDF version of the user manual for OpenEMM 2019 is now available at
Here is a video with first steps:
If you want OpenEMM to automatically launch at server reboot, you can use a systemd unit file for that purpose. Create a new file openemm.service in directory /etc/systemd/system/ with the following content:
[Unit] Description=OpenEMM startup script After=var-run.mount network.target local-fs.target time-sync.target sendmail.service postfix.service [Service] User=openemm Group=openemm Type=oneshot RemainAfterExit=true ExecStart=/home/openemm/bin/openemm.sh start ExecStop=/home/openemm/bin/openemm.sh stop TimeoutSec=300 StandardOutput=journal+console [Install] WantedBy=multi-user.target
After deploying this file, reload the systemd-daemon and enable the openemm service with
# systemctl daemon-reload # systemctl enable openemm
At next server reboot, OpenEMM will be started automatically.
Frontend 20.04.000.188 or later:
Frontend 20.04.000.185 or later:
Frontend 20.04.000.155 or later:
Frontend 19.10.000.133 or later:
Frontend 19.10.000.131 or later:
Frontend 19.04.000.488 or later:
Frontend 19.04.000.465 or later:
Frontend 19.04.000.459 or later:
Frontend 19.04.000.439 or later:
Frontend 19.04.000.430 or later:
Frontend 19.04.000.422 or later:
Frontend 19.04.000.369 or later:
Frontend 19.04.000.314 or later:
Frontend 19.04.000.314 or later:
Frontend 19.04.000.312 or later:
Frontend 19.04.000.310 or later:
Frontend 19.04.000.268 or later:
Backend 20.04.000.190 or later:
Backend 20.04.000.181 or later:
Backend 19.04.000.441 or later:
Backend 19.04.000.418 or later:
Backend 19.04.000.388 or later:
Backend 19.04.000.329 or later:
Runtime 19.10.009.016 or later:
Runtime 19.10.009.015 or later:
Runtime 19.10.009.012 or later:
Runtime 19.10.004.010 or later:
Runtime 19.07.015 or later:
Runtime 19.07.011 or later:
Runtime 19.07.005 or later:
Runtime 19.07.004 or later:
Runtime 19.04.091 or later:
Runtime 19.04.090 or later:
Runtime 19.04.085 or later:
Runtime 19.04.079 or later:
Manual 20.04.010 or later:
Download the source code of OpenEMM 2019 from GitHub at https://github.com/agnitas-org/openemm to a directory of your choice.
$ sudo su - # cd backend # ./build-backend.py
Copy template files build.properties.default, build-birt.properties.default and build-ws.properties.default to files with names build.properties, build-birt.properties and build-ws.properties and adapt the paths mentioned in these 3 files to your needs.
$ cd frontend $ ant -f build.xml