User Tools

Site Tools


start

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
start [2020/01/04 18:33] – [8.2 Fixed Issues] mastart [2024/04/17 16:03] (current) – [2. Basic Requirements] ma
Line 1: Line 1:
-====== OpenEMM Install & Configuration Wiki ====== +====== OpenEMM Installation & Configuration Wiki ====== 
-Latest Version of **OpenEMM 19.04**: Backend: 19.04.000.**441**, Frontend19.04.000.**488**\\ +Latest version of **OpenEMM 24.04**: 24.04.000.**043**\\ 
-Latest Version of **OpenEMM 19.10**: Backend: 19.10.000.**128**, Frontend19.10.000.**133**\\ +Latest version of **OpenEMM 23.10**: 23.10.000.**170**\\ 
-Utility Package for Deployment & Runtime19.10.009.015\\ +Latest version of **OpenEMM 23.04**: 23.04.000.**231**\\ 
-(as of December 10, 2019) +Latest version of **OpenEMM 22.10**: 22.10.000.**230**\\ 
- +Latest version of **OpenEMM 22.04**22.04.000.**238**\\ 
-**This wiki provides the brief version of the extensive {{ ::openemm_install_admin_guide_2019_1.2.0.pdf|OpenEMM Installation & Administration Guide 1.2.0}} (including SLES instructions).\\+Latest version of **OpenEMM 21.10**: 21.10.000.**108**\\ 
 +(as of April 12, 2024)\\
 \\ \\
- We kindly ask you to contribute your feedback and questions to improve the documentationinstallationconfiguration and administration of OpenEMM! Please leave your questions and comments in the OpenEMM forum at [[https://forum.openemm.org|forum.openemm.org]].**+**OpenEMM is a web based enterprise application for email and marketing automation. It is used for automated email communication with customersleadsmembers and employees. OpenEMM is published under open source license** [[https://www.gnu.org/licenses/agpl-3.0.en.html#license-text|APGLv3]].\\ 
 +And should you outgrow OpenEMM in the future, you may __seamlessly__ upgrade to OpenEMM Plus (https://www.agnitas.de/en/e-marketing_manager/email-marketing-software-variants/openemm/#openemm-plus).\\
 \\ \\
-\\ +**Videos of OpenEMM:**
-===== 1. Introduction ===== +
-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 [[https://github.com/agnitas-org/openemm|GitHub]]. It uses the popular open source license [[https://www.gnu.org/licenses/agpl-3.0.en.html|AGLPv3]]. At the end of this page you can find instructions on how to build OpenEMM by yourself. +
-\\ +
-\\ +
-===== 2. Requirements =====+
  
-  RedHat 7 or CentOS 7 64 bit, or [[suse|SLES 15]] (OpenEMM 19.10 and later) +**Brief introduction of OpenEMM:**
-    * with VirtualBoxWindows, macOS or any other Linux -> see section [[virtualbox|OpenEMM on VirtualBox]] for details +
-  Java Open JDK 8 +
-  Apache Tomcat 9 +
-  * Python 2.7 (3.x with future version OpenEMM 20.04) +
-  * MySQL 5.6 or 5.7, or MariaDB 10.1, 10.2 or 10.3 +
-  * Sendmail 8.10 or later, or Postfix 2.6 or later +
-  * wkhtmltox 0.12.2.1 or later +
-  * for HTTPS support: Apache Tomcat Native Library +
-\\ +
-\\ +
-===== 3. Preparations =====+
  
-OpenEMM consists of 2 packages: +<html><iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/3zl6dpyO5jY?si=8AddM3G7J_tlKnrq" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe></html>
-  backend code for generation and dispatch of emails, management of bounces and replies: openemm-backend-19.*.000.*.tar.gz +
-  frontend code with GUI, statistics service (charts & diagrams) and webservices: openemm-frontend-19.*.000.*.tar.gz+
  
-We also offer a utility package for easy deployment and operations of the binary code of OpenEMM: openemm-runtime-19.*.tar.gz+**Features of OpenEMM and new Features of OpenEMM 23.10 (German language):**
  
-Unless noted otherwise below, use user "root".+<html><iframe width="280height="158" src="https://www.youtube-nocookie.com/embed/WP3JX_l9iKQ?si=uyqv7EVNN5oPVcNI" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe></html> 
 +<html><iframe width="280" height="158" src="https://www.youtube-nocookie.com/embed/Zx97gvTI8uQ?si=7Lffpr2K8FQqkAUl" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe></html>
  
-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 [[suse|here]].+**Installation and Updates (German language):**
  
-==== 3.1 Packages of Operating System ==== +<html><iframe width="280" height="158" src="https://www.youtube-nocookie.com/embed/cRfDPBaBQ4o?si=C53cOXo5ymYCP_FW" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe></html
-Install the required packages:\\ +<html><iframe width="280" height="158" src="https://www.youtube-nocookie.com/embed/v9pPRpmfLSc?si=iGKA5wLtKq1PYiCI" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe></html>
-<code+
-# 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 +
-</code>+
  
-==== 3.2 DBMS ==== +**Commercial Support Services and OpenEMM Plus (German language):**
-Depending on the DBMS you want to use, either install MariaDB or MySQL.\\ +
-\\ +
-MariaDB and MySQL code repository for **RedHat7:** +
-<code> +
-# subscription-manager repos –enable rhel-server-rhscl-7-rpms +
-</code> +
-MariaDB and MySQL code repository for **CentOS7:** +
-<code> +
-# yum install centos-release-scl +
-</code> +
-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.+
  
-=== MariaDB DBMS === +<html><iframe width="280" height="158" src="https://www.youtube-nocookie.com/embed/iCg3SxyORAA?si=UuDFG9UFzXn8Q07N" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe></html
-This example uses MariaDB 10.2: +<html><iframe width="280" height="158" src="https://www.youtube-nocookie.com/embed/tLSKVs8dY-s?si=ewX_jhRlSsD9PJpk" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe></html>
-<code> +
-# yum install rh-mariadb102-mariadb-server +
-# yum install MySQL-python +
-</code> +
-Make sure MariaDB is running and re-started at every server reboot: +
-<code> +
-# systemctl enable rh-mariadb102-mariadb +
-# systemctl start rh-mariadb102-mariadb +
-</code> +
-Finally, set a symlink to make sure that OpenEMM can find MariaDB: +
-<code> +
-# cd /bin +
-# ln -/opt/rh/rh-mariadb102/root/bin/* . +
-</code> +
-=== MySQL DBMS === +
-This example uses MySQL 5.7: +
-<code> +
-# yum install rh-mysql57-mysql-server +
-# yum install MySQL-python +
-</code> +
-Make sure MySQL is running and re-started at every server reboot: +
-<code> +
-# systemctl enable rh-mysql57-mysql +
-# systemctl start rh-mysql57-mysql +
-</code> +
-Finally, set a symlink to make sure that OpenEMM can find MySQL: +
-<code> +
-# cd /bin +
-# ln -s /opt/rh/rh-mysql57/root/bin/* . +
-</code>+
  
 +You can download the source code of OpenEMM at GitHub: https://github.com/agnitas-org/openemm
 +\\
 +If you do not want to compile and deploy the source code of OpenEMM manually, we recommend to download the package for OpenEMM deployment & runtime at https://www.agnitas.de/en/download/openemm-binaries/ . This package contains the OpenEMM Maintenance Tool (OMT) which lets you download, install, configure, update and maintain OpenEMM.\\
 +Alternatively, you may download the source code of OpenEMM from GitHub and compile and deploy the software manually yourself. See the instructions at the end of this page.
  
-==== 3.3 MTA ==== +  * **Factsheet OpenEMM 24.04 (EN): {{ :agnitas-openemm-neuerungen-version-24.04-en.pdf |Factsheet for OpenEMM 24.04}}** 
-Depending on the MTA you want to use, either install Sendmail or Postfix.+  * **Factsheet OpenEMM 24.04 (DE): {{ :agnitas-openemm-neuerungen-version-24.04-de.pdf |Factsheet für OpenEMM 24.04}}**
  
-=== MTA Sendmail === +  * Javascript Widget to generate Subscribe Forms (EN + DE): {{ :emm-subscribe-toolbox.zip |Javascript Widget Toolbox}}
-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. +
-<code> +
-# systemctl stop postfix +
-# yum remove postfix +
-# yum install sendmail sendmail-cf sendmail-milter procmail +
-</code> +
-After that, if necessary, switch the default SMTP server to Sendmail with +
-<code> +
-# alternatives --set mta /usr/sbin/sendmail.sendmail +
-</code> +
-and change Sendmail's configurationOpen file __sendmail.mc__ in directory __/etc/mail__ and add a leading "dnl " to line +
-<code> +
-DAEMON_OPTIONS(`Port=smtp,Addr=127.0.0.1, Name=MTA')dnl +
-</code> +
-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 +
-<code> +
-INPUT_MAIL_FILTER(`bav', `S=unix:/home/openemm/var/run/bav.sock, F=T')dnl +
-</code> +
-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: +
-<code> +
-# cd /etc/mail +
-# umask 022 +
-# [ -f relay-domains ] || touch relay-domains +
-# [ -f mailertable ] || touch mailertable +
-</code> +
-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 +
-<code> +
-# cd /etc/mail +
-# make +
-# systemctl restart sendmail +
-</code>+
  
-=== MTA Postfix === +The guide to installation and administration of OpenEMM can be found here: 
-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. +  * OpenEMM 24.04: {{ ::openemm_24.04_install_admin_guide_1.0.1.pdf|OpenEMM 24.04 Installation & Administration Guide 1.0.1}} 
-<code> +  * OpenEMM 23.10{{ ::openemm_23.10_install_admin_guide_1.0.5.pdf|OpenEMM 23.10 Installation & Administration Guide 1.0.5}} 
-# systemctl stop sendmail +  * OpenEMM 23.04{{ ::openemm_23.04_install_admin_guide_1.0.2.pdf|OpenEMM 23.04 Installation & Administration Guide 1.0.2}} 
-# yum remove sendmail +  * OpenEMM 22.10{{ ::openemm_22.10_install_admin_guide_1.0.1.pdf|OpenEMM 22.10 Installation & Administration Guide 1.0.1}} 
-# yum install postfix sendmail-milter procmail +  * OpenEMM 22.04{{ ::openemm_22.04_install_admin_guide_1.0.0.pdf|OpenEMM 22.04 Installation & Administration Guide 1.0.0}} 
-</code> +  * OpenEMM 21.10: {{ ::openemm_21.10_install_admin_guide_1.0.6.pdf|OpenEMM 21.10 Installation & Administration Guide 1.0.6}}
-After that, switch the default SMTP server to Postfix with +
-<code> +
-# alternatives --set mta /usr/sbin/sendmail.postfix +
-</code> +
-and change Postfix' configuration to unleash all featuresTo do this, change to the Postfix main configuration directory+
-<code> +
-# cd /etc/postfix +
-</code> +
-and add some configuration parameters to Postfix' main configuration file __main.cf__: +
-<code> +
-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 = +
-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 +
-</code> +
-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 serverOtherwise, mails would be sent with sender domain localhost.localdomain instead.\\ +
-\\ +
-Finally, add these lines to configuration file __master.cf__+
-<code> +
-mailloop  unix  -                               pipe +
-  flags=RX user=openemm argv=/usr/bin/procmail /home/openemm/lib/bav.rc +
-</code> +
-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.eremoving the leading #) line +
-<code> +
-tlsmgr unix - - n 1000? tlsmgr +
-</code> +
-to permit sending of TLS encrypted emails.\\ +
-To activate your changes, restart Postfix with +
-<code> +
-# systemctl restart postfix +
-</code>+
  
-==== 3.4 wkhtmltox ==== +We also offer an [[virtualbox|OVA version]] for OpenEMM 23.10: https://share.agnitas.de/index.php/s/KD84KNkaxg8Bd5X/download (see section [[virtualbox|OpenEMM on VirtualBox]] for details)
-Download the RPM of "wkhtmltox" from [[https://wkhtmltopdf.org|wkhtmltopdf.org]] and unpack it: +
-<code> +
-# rpm -ihv wkhtmltox-*.rpm +
-</code>+
  
-==== 3.5 Firewall ==== +We kindly ask you to contribute feedback for OpenEMM! Please leave any bug findingy, questions and comments in the OpenEMM forum at https://forum.openemm.org . This helps us to improve the code, installation, configuration, administration and documentation of OpenEMM.
-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: +
-<code> +
-# firewall-cmd --get-active-zones +
-</code+
-If your zone is "public" (if notuse the zone name you got with the aforementioned statement): +
-<code> +
-# 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 +
-</code>+
 \\ \\
 \\ \\
-===== 4. Installation ===== +==== More resources: ==== 
-==== 4.1 Group and User ==== +Here is a video with first steps: 
-Create group and user for OpenEMM: +  * https://youtu.be/WBnkq1pzprY (English) 
-<code> +  * https://youtu.be/9iw81WGoXWE (German)
-# groupadd openemm +
-# useradd -m -g openemm -d /home/openemm -s /bin/bash openemm +
-# passwd openemm +
-# su - openemm +
-</code>+
  
-==== 4.2 OpenEMM Download ====+If you want to install the context-sensitive online help feature of OpenEMM (including the user manual with about 500 pages), visit 
 +  * https://www.agnitas.de/en/download/openemm-manual/ (English) 
 +  * https://www.agnitas.de/download/openemm-handbuch/ (German) 
 +to get the download link for the manual package (which contains both, the English and the German version of the documentation). You can also use OMT’s menu "Install or update package from AGNITAS Cloud" to install the documentation. 
 +----
  
-We recommend to download the latest deployment & runtime package of OpenEMM from [[https://www.agnitas.de/en/download/openemm-binaries/|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.+===== 1. Introduction ===== 
 +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 software is not artificially limited in any way, because we will not try to push you to use a commercial cloud OpenEMM service instead. You are free to operate OpenEMM on whatever hardware you like, depending on the performance you need. And there is no need to use a (paid) email relay service!\\ 
 +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 [[https://github.com/agnitas-org/openemm|GitHub]]It uses the popular open source license [[https://www.gnu.org/licenses/agpl-3.0.en.html|AGLPv3]]. At the end of this page you can find instructions on how to build OpenEMM by yourself. 
 +----
  
-==== 4.3 Runtime Deployment ==== +===== 2Basic Requirements =====
-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 openemmunpack and start it with +  * RedHat 7 to 9; AlmaLinux 8 or 9; SLES 15 
-<code+    * with VirtualBox: WindowsmacOS or any other Linux -see section [[virtualbox|OpenEMM on VirtualBox]] for details 
-# su - openemm +  Java Open JDK 11 or 17 
-$ tar -xvzpf openemm-runtime-19.*.tar.gz +  Apache Tomcat 10.(including NIO Connector for HTTPS support) 
-$ ./OpenEMMInstaller.sh +  * Python 3.8 or later 
-</code> +  DBMS: MariaDB 10.5 or 10.6 
-**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*+  MTA: Postfix 2.6 or later
-<code> +
-$ ln -s /home/openemm/tomcat/bin/openemm.sh /home/openemm/bin/openemm.sh +
-</code> +
-**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 +----
-  * JAVA_HOME (default: /usr/lib/jvm/java) for Java +
-  * CATALINA_HOME (default: /home/openemm/opt/tomcat/) for Tomcat +
-  * WKHTML (default: /usr/bin/wkhtmltoimage) for tool wkhtmltox +
-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: +===== 3Mailing Templates and Forms ===== 
-<code> +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".** 
-$ sudo su - +----
-/home/openemm/bin/OpenEMMInstaller.sh +
-</code>+
  
-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.+===== 4. Updates ===== 
 +The top of this Wiki lists the latest available versions of OpenEMM backendfrontend and the deployment & runtime package
  
-==== 4.4 Frontend and Backend Deployment ==== +You can download the latest versions of packages with menu "Install or update package from AGNITAS Websiteof OMT (OpenEMM Maintenance Tool). An update of the code will also update the schema of the OpenEMM database, if necessary.
-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: +
-<code> +
-$ sudo su - +
-# /home/openemm/bin/OpenEMMInstaller.sh +
-</code> +
-Use menu "Install or update package from AGNITAS websiteto 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": +If you do not use the latest version of OpenEMM, OMT offers you to upgrade to a new releaseIf 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".
-<code> +
-# su - openemm +
-$ OpenEMMInstaller.sh +
-</code> +
-When the frontend is installedthe OpenEMM database is automatically filled with its initial content. +
-\\ +
-\\ +
-===== 5Configuration =====+
  
-==== 5.1 Log Access ==== +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 mailingor right after the dispatch (due to the brief downtime of the redirect service causing missed openings and click redirects). 
-OpenEMM requires read access to the mail log file at **/var/log/maillog** and logrotate has to be aware of this facttoo. Open file **/etc/logrotate.d/syslog** and add the following line after the line sharedscripts: +----
-<code> +
-# create 0644 +
-</code> +
-and run +
-<code> +
-# chmod 644 /var/log/maillog +
-</code> +
-to set the permissions of the current maillog.+
  
-==== 5.2 OpenEMMInstaller ==== +===== 5. Administration ===== 
-Use menu "Configuration and "Security" of OpenEMMInstaller to set up and change the configuration of OpenEMM.+See the Installation & Administration Guides linked at the top of this document for extensive information on administration of OpenEMM. 
 +----
  
-Set various essential parameters in sub-menu "Change emm.properties" of menu "Configuration":\\ +===== 6Known Issues =====
-  * Set //system.url// and //birt.drilldownurl// to the protocol and FQDN of your OpenEMM server (like https://openemm.example.com) +
-  * Set //birt.url// to the same value as //birt.drilldownurl// and add "/birt" at the end (like https://openemm.example.com/birt)+
  
-Use menu "Configuration", sub-menu "Change client/account data in db" to set important values in the OpenEMM database: +==== 6.1 Open Issues ==== 
-  * Set //rdir_domain// to the protocol and FQDN of your OpenEMM server, for example https://openemm.example.com. This domain will be used in all measureable links to redirect them through OpenEMM+  * Mailing scheduled for sending later than 1 hour in the future are not sent
-  * Set //mailloop_domain// to the domain of your sender address. The domain for the mailloop service must be different from the name of your OpenEMM server. It usually is the FQDN which is defined in the MX record for your server, for example mailing.example.com, pointing as MX to openemm.example.com. In this case, use domain mailing.example.com as domain for the sender address of your mailings. (There are other ways for configuration, described in the OpenEMM Install&Admin Guide.) If you do not configure the mailloop service, OpenEMM can only process instant bounces, i.e. you will not be able to catch all bounces (see section [[start#mailloop_configuration|Mailloop Configuration]] below).+
  
-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.+==== 6.2 Fixed Issues ==== 
 +  * nothing fixed
  
-Launch OpenEMM with menu "Restart OpenEMM". Experts may have a look at the Tomcat log during startup with +----
-<code> +
-$ tail -f logs/catalina.out +
-</code> +
-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.+===== 7Building OpenEMM yourself =====
  
-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).+Download the source code of OpenEMM from GitHub at https://github.com/agnitas-org/openemm to a directory of your choice.
  
-==== 5.3 Templates and Forms ==== +==== Backend ====
-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".**+
  
-==== 5.4 Mailloop Configuration ==== 
-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 [[mailoop|OpenEMM Mailloop Configuration]] for details. 
-\\ 
-\\ 
-===== 6. Updates ===== 
-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 19.10.009.010 or later, you are offered to upgrade to new release OpenEMM 19.10. 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). 
- 
-Beginning with runtime version 19.07.011 you can simplify the update process even more. Simply start OpenEMMInstaller from the command line with option "-update" (use //sudo// to be able to update the backend): 
 <code> <code>
-sudo /home/openemm/bin/OpenEMMInstaller.sh -update+git clone https://github.com/agnitas-org/openemm 
 +$ cd openemm/backend 
 +$ chmod 755 build-backend.py 
 +$ ./build-backend.py 
 </code> </code>
-In this case, if OpenEMMInstaller finds and applies an update, and it automatically restarts OpenEMM afterwards. 
-\\ 
-\\ 
-===== 7. Administration ===== 
-==== 7.1 Ressources ==== 
-The beta PDF version of the user manual for OpenEMM 2019 is now available at 
-  * https://www.agnitas.de/en/download/openemm-manual/ (English) 
-  * https://www.agnitas.de/download/openemm-handbuch/ (German) 
  
-Here is a video with first steps: +==== Frontend ==== 
-  * https://youtu.be/mqFwfrFxSD8 (English) +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 listed in those three files to your needs.
-  * https://youtu.be/9iw81WGoXWE (German) +
-\\ +
-==== 7.2 Automated Startup  ==== +
-If you want OpenEMM to automatically launch at server rebootyou can use a systemd unit file for that purposeCreate a new file **openemm.service** in directory **/etc/systemd/system/** with the following content:+
 <code> <code>
-[Unit] +$ cd openemm/frontend 
-Description=OpenEMM startup script +$ ant -f build.xml 
-After=var-run.mount network.target local-fs.target time-sync.target sendmail.service postfix.service+</code>
  
-[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] +===== 8. New Features of OpenEMM 24.04 (major changes) ===== 
-WantedBy=multi-user.target +  * E-10353: New method for SOAP API to pause and resume a campaign 
-</code>+  * E-10301: If JWT expires, a new JWT has to be generated using user/password credentials (REST API) 
 +  * E-10272: option to extract recipient specific information from mail replies, put this info in X-Headers and forward the replies with these X-Headers to a configurable email adress  
 +  * E-10240: domain statistics can now compare data of up to 50 domains 
 +  * E-10187: option to delete openings and clicks of all admin and test recipients when activating mailing dispatch 
 +  * E-10136: **extension of report according to EU GDPR §15 ("Right of access by the data subject")** 
 +  * E-10104: improvement of bounce reporting for mailings older than 90 days 
 +  * E-9886: option to override the global defined sending speed with a (lower) sending speed for a certain mailing 
 +  * E-9747: new RESTful method to list all templates of a tenant 
 +  * E-9689: improved usability of feedback regarding password security 
 +  * E-9616: sender addresses can be predefined for mailing lists (requires 24.04.000.045 or later) 
 +  * E-9445: Javascipt widget to generate subscribe form 
 +  * E-9246: when clicking on an entry in the list of datasource IDs redirect the EMM user to the recipients who are related to this datasource ID 
 +  * E-9163: when a mailing is cancelled, copied and sent again, the original statistic data are no longer deleted but added to the copied mailing 
 +  * E-9043: improved online archive functionality 
 +  * E-8866: new tag agnWEBVIEW to insert a link in a mailing that calls its webview in a web browser 
 +  * E-8555: prevent changes of already generated or sent mails bei SOAP webservices 
 +  * E-8517: REST method ListMailings extended with optional filters 
 +  * E-8142: show size of free server disk space on system status page (LTS only) 
 +  * E-8132: **hard bounces detected on a certain mailing list will be applied globally to all mailing lists to prevent triggering of spam traps** 
 +  * E-7480: new statistic showing all existing remarks for changes of recipient status (like opt-ins and opt-outs) and how often they happened 
 +  * E-7164: extended import protocol with number of unsubscribed and blocklisted recpients 
 +  * E-7108: new tag agnAGE for mailing content (calculating the age based on a date) 
 +  * E-6986: export optionally delivers data that is represented by numbers in EMM (like gender, mailtype or user status) as descriptive text 
 +  * E-4539: **import supports Excel format for import of recipient profile field content** 
 +  * G-5746: optional email notification service for passwords that are about to expire 
 +  * G-4078: **various configurable statistic reports (PDF and CSV) which can be sent by email at pre-defined times** 
 +  * L-1140: automatic cancellation of blocked imports due to missing user input 
 +  * L-1273: automatically update start date in the past to "now" when activating a workflow 
 +  * S-2482: import and export support file formats tar, gz and tar.gz
  
-After deploying this file, reload the systemd-daemon and enable the openemm service with +----
-<code> +
-# systemctl daemon-reload +
-# systemctl enable openemm +
-</code>+
  
-At next server reboot, OpenEMM will be started automatically. +===== 9New Features of OpenEMM 23.10 (major changes) ===== 
-===== 8Known Issues =====+  * E-10132: option to permit/prevent import of HTML code in profile fields 
 +  * E-10083: new recycle bin so that deleted mailings can be recovered 
 +  * E-10056: pre-header supports use of tag agnDYN 
 +  * E-10037: cleanup of mail loop processing by no longer used domains 
 +  * E-10003: new RESTful method to retrieve system information of EMM instance 
 +  * E-9906: improved detection of mailing links in proprietary HTML code used for Microsoft Outlook 
 +  * E-9882: improved usability of auto-optimization in workflow manager 
 +  * E-9722: improvement of import speed 
 +  * E-9482: images tab of web forms accepts upload of ico files now 
 +  * E-9215: new option to export the original HTML code of an email in the preview tab 
 +  * E-8906: pre-fill new workflows automatically with a start and a recipient icon 
 +  * E-8792: sending options for regular mailings now available for date-based mailings too 
 +  * E-8781: new option to define a pre-header in settings of a mailing 
 +  * E-8700: option to make links trackable that are provided out of a profile field 
 +  * E-8517: RESTful method ListMailings provides filter options 
 +  * E-8474: option to send out a date based mailing more than once a day 
 +  * E-8260: keep deleted mailing links working for mails already sent out 
 +  * E-8225: option to display the plan date of a mailing in the mailing overview 
 +  * E-7112: extend mailing related SOAP webservices with option to set planned date 
 +  * E-6484: new option to pause and resume a workflow in case of changes needed for the involved mailings 
 +  * G-5664: send test mails based on the selected preview to the current EMM user 
 +  * G-5650: new selection to send a test mail to the email address of the current EMM user 
 +  * G-5593: changes to fix values for profile fields are logged to UAL 
 +  * G-5591: option to list deleted links in link tab of mailing 
 +  * G-5585: automatic cancellation of imports blocked due to missing EMM user input to avoid blocking of further imports 
 +  * G-5519: more thorough validation of worklow design at activation time 
 +  * G-5471: visually improved rendering of thumbnails and PDF reports 
 +  * O-0640: OpenEMM can import templates and mailings created with commercial EMM 
 +  * P-1690: option to use JSON Web Token for Authentification to access RESTful API 
 +  * P-1596: OMT checks integrity of downloaded EMM tarballs via checksums 
 +  * S-2463: pre-headers supports agnDYN tag as placeholder
  
-==== 8.1 Open Issues ==== +----
-  * O-291: content for help menu is not available yet for download. **Workaround:** Beta version of PDF manual at https://www.agnitas.de/en/download/openemm-manual/+
  
-==== 8.2 Fixed Issues ==== +===== 10New features of OpenEMM 23.04 (major changes) ===== 
-Frontend 19.10.000.133 or later: +  * E-9768SOAP webservice method “ListSubscriber” supports EQL code as filter argument 
-  * O-400: Export wizard does not allow change of character set +  * E-9745new RESTful methods to manage EMM forms 
-Frontend 19.10.000.131 or later+  * E-9571extend dashboard with capability to copy mailings 
-  * E-7031: Login does not work with IPv6 addresses +  * E-9392new filter options for list of mailings 
-Frontend 19.04.000.488 or later+  * E-9381improved functionality and usability of import/export logs list in data management menu 
-  * O-381: Export wizard can not be launched +  * E-9125show trigger IDs in list of triggers 
-Frontend 19.04.000.465 or later+  * E-8908: new start and stop icon for workflow manager 
-  * O-366: Action type "modify profile" can not be created +  * E-8907rearrangement of workflow manager layout to increase the canvas horizontally 
-Frontend 19.04.000.459 or later+  * E-8904significantly extended statistics for workflows 
-  * G-4109administration of import profile settings does not work +  * E-8902option to show grid in canvas of workflow manager 
-Frontend 19.04.000.439 or later: +  * E-8381separate tabs in user activity log for activities of SOAP API and RESTful API 
-  * O-360: WSDL document to auto-generate webservice client is not accessible at <domain>/2.0/emmservices.wsdl +  * E-8225show scheduled send dates in list of mailings 
-Frontend 19.04.000.430 or later: +  * E-7376Visually improved statistics for mailing comparision 
-  * G-4156: "sub-menu "Edit field content" of menu "Import/Export" not available +  * E-7367more detailed error message why a certain target group can not be deleted 
-Frontend 19.04.000.422 or later: +  * E-7332more detailed error message if a new recipient profile field could not be created 
-  * O-356: recipient, domain and monthly statistics are missing +  * G-5250redesign of various bulky multi-selection lists to light label lists 
-Frontend 19.04.000.369 or later: +  * G-5212it is now possible to replace the AGNITAS logos in EMM with customized logos (via OMT) 
-  * O-350: in some cases wktohtmlx tool is not found by OpenEMM +  * L-1006changing once password in the selfservice section explicitly requires the user to enter his/her old password first
-Frontend 19.04.000.314 or later: +
-  * O-338: import wizard mode does not accept changed character set +
-Frontend 19.04.000.314 or later: +
-  * O-334: it is not possible to revoke permissions of a user +
-Frontend 19.04.000.312 or later: +
-  * O-337it is not possible to create a new import profile +
-Frontend 19.04.000.310 or later: +
-  * O-336: workflow manager can not create new workflows +
-Frontend 19.04.000.268 or later: +
-  * O-328: validator prevents some mailings from being saved +
-\\ +
-Backend 19.04.000.441 or later+
-  * O-362optional individual setting of envelope email address is ignored +
-Backend 19.04.000.418 or later: +
-  * O-358menu "Show OpenEMM status" of OpenEMMInstaller shows status of backend +
-Backend 19.04.000.388 or later: +
-  * G-4254backend does not send all mails generated by WM +
-Backend 19.04.000.329 or later: +
-  * O-340mailloop service not reachable due to invalid path +
-\\ +
-Runtime 19.10.009.015 or later: +
-  * O-403: Tomcat updates by the OpenEMMInstaller could overwrite individual configuration (like TLS settings) +
-Runtime 19.10.009.012 or later: +
-  * O-401: In some cases the OpenEMMInstaller did not launch when installed for the very first time +
-Runtime 19.10.004.010 or later: +
-  * O-396In some cases the OpenEMMInstaller can not create the initial database for OpenEMM +
-Runtime 19.07.015 or later: +
-  * O-365: deploy & runtime package creates symlink to openemm.sh in /home/openemm/bin only after update +
-Runtime 19.07.011 or later+
-  * simplified update process with "OpenEMMInstaller.sh -update" +
-Runtime 19.07.005 or later: +
-  * O-281: menu 4 of OpenEMMInstaller also offers to update deployment & runtime package +
-Runtime 19.07.004 or later: +
-  * O-358menu "Show OpenEMM status" of OpenEMMInstaller shows status of backend +
-Runtime 19.04.091 or later: +
-  * O-350: in some cases wktohtmlx tool is not found by OpenEMM +
-Runtime 19.04.090 or later: +
-  * O-343: OpenEMM Installer offers Tomcat 9.0.21 now, because 9.0.16 is no longer safe due to a disclosed DOS vulnerability +
-Runtime 19.04.085 or later: +
-  * O-272Runtime update removes symlink for backend libraries +
-Runtime 19.04.079 or later: +
-  * O-272: sub-menu 3 of menu 2 in OpenEMMInstaller does not work +
-\\ +
-===== 9. New Features of OpenEMM 19.10 =====+
  
-  * E-6653: (reminder) campaigns can be sent to recipients with status "waiting for confirmation" +----
-  * E-6587: improved filtering of invalid form data +
-  * E-6553: profile field cleaning for recipients without active binding after 30 days (data minimization) +
-  * E-6390: add bcc option for optional email archive to date triggered mailings +
-  * E-6292: if a search for an email address does not produce a hit, offer to create a new recipient with this address +
-  * E-6249: improved usability for visual target group editor +
-  * E-5438: email header "List-Unsubscribe" supports RFC 8058 for one-click unsubscriptions +
-  * O-363: make OpenEMM work with Suse Linux 15 +
-  * G-4051: context-sensitive auto-complete suggestions for EQL editor +
-  * B-849: new field entry_mailing_id in customer_binding_tbl for mailing that caused opt-in +
-  * B-844: new link hash tag for encyption of data field +
-  * various minor usability improvements like easier navigation, better formatting and sorting, optimized default settings, more precise notifications, better warning and error messages, new help balloons, additional logging of user activities, etc. +
-  +
-===== 10. Roadmap for OpenEMM 20.04 (as of November 15) ===== +
-  * E-6934: show fields of default salutations as read-only +
-  * E-6905: show by which actions an action-based mailings is used +
-  * E-6901: keep search parameters for multiple recipient searches +
-  * E-6883: bulk delete feature for images +
-  * E-6841: improved usability for creating date-based target groups +
-  * E-6824: "used in" tab of target groups extended with mailing content blocks and export profiles as "used in" sources +
-  * E-6762: improve usability of page to edit mailing contents +
-  * E-6468: redesign of configuration page in tab "send mailing" +
-  * E-5987: edit lock for mailing content if more than one user tries to change it at the same time +
-  * E-5839: when a newly entered email address already exist, offer to show (and edit) its profile data +
-  * E-5583: new math tag agnDAYS_UNTIL +
-  * E-5496: show anonymous openings and clicks over time in separate charts +
-  * E-5223: detect duplicate recipients in EMM database +
-  * E-4542: end device type as selector for heatmap statistics +
-  * E-2609: assess complexity of target groups and show resulting performance indicators +
-  * E-0707: redesign of left navigation bar +
-  * G-4289: reworked link tab for user forms  +
-  * various minor usability improvements like easier navigation, better formatting and sorting, optimized default settings, more precise notifications, better warning and error messages, new help balloons, additional logging of user activities, etc.+
  
-===== 11. Building OpenEMM yourself =====+===== 11. New features of OpenEMM 22.10 (major changes) ===== 
 +  * E-9482: accept files of “ico” format for EMM web forms and mediapool 
 +  * E-9447: offer an extended version of the WYSIWYG editor which shows more option to manipulate content 
 +  * E-9422: option to hide WYSIWYG editor completely 
 +  * E-9399: new RESTful API method to provide statistic numbers for mailing, recipients and mailing lists 
 +  * E-9210: show preview of mailing even when no test recipient exists 
 +  * E-8384: option to set a treshold for a data-based mailing which blocks email dispatch if a certain number of recipients would be exceeded 
 +  * E-8146: Quotas for SOAP Webservice API and RESTful API are active by default to reduce the impact of API floodings 
 +  * E-7150: decouple scrolling of preview on the right side from scrolling of the content blocks on the right side in the content tab of mailings 
 +  * E-7093: introduce character counter for subject line and text blocks of mailing content 
 +  * E-6250: show status icon of mailing in tab “Send Mailing” 
 +  * E-5966: WYSIWYG editor offers to insert emojis 
 +  * E-2138: agnIMAGE tag can be used in EMM web forms too 
 +  * E-873: improved check of file formats to avoid upload of malware for mailing attachments, mediapool, EMM upload menu, etc. 
 +  * E-713: introduced confirmation question with additional information when activating or deactivating action based or date based mailings 
 +  * L-896: show menu options that send out emails to EMM admins only, if the needed email addresses are set (like buttons for support or upload orders) 
 +  * L-754: optional WYSIWYG editor with limited functionality 
 +  * O-475: new icon indicating hanging jobs in job list of system status menu
  
-Download the source code of OpenEMM 2019 from GitHub at https://github.com/agnitas-org/openemm to a directory of your choice.+----
  
-==== Backend ====+===== 12. New features of OpenEMM 22.04 (major changes) ===== 
 +  * E-8945: if the same web browser is used for more than one tenant, settings for GUI formatting are saved separately for each tenant 
 +  * E-8936: do not accept potentially dangerous UTF characters for code of action scripts 
 +  * E-8923: renamed Blacklist and Whitelist to Blocklist and Allowlist 
 +  * E-8796: Split RESTful users and GUI users and offer separate tab for configuration of RESTful users 
 +  * E-8762: links generated by agnFORM, agnPROFILE and agnUNSUBSCRIBE use CToken instead of CI 
 +  * E-8744: Optionally define columns with fixed values to be included in CSV export file 
 +  * E-8686: use date picker for all date fields without time 
 +  * E-8644: new time delay values for action based mailings 
 +  * E-8640: new option for action “send action-based mail” to include or to exclude subscribed recipients  
 +  * E-8589: duplicate analysis now can work case sensitive or case insensitive 
 +  * E-8588: RESTful API normalizes email addresses to lower case by default 
 +  * E-8551: show hint if speed of Internet connection is less than 750 kbps 
 +  * E-8513: improved progress bar for import and export jobs 
 +  * E-8430: added meaningful default values for mailing import 
 +  * E-8245: honor tracking veto in realtime, i.e. even links of e-mails sent before tracking veto will not be tracked any longer 
 +  * E-7686: new option to globally activate tracking veto for all recipients of tenant 
 +  * G-4404: visual web form builder 
 +  * S-2270: expand SOAP webservice method ListMailings with filter option 
 +  * S-2223*: added various new methods to RESTful API (update mailing, copy mailing, get mailing status, add/update/list target groups)
  
-<code> +----
-$ sudo su - +
-# cd backend +
-# ./build-backend.py +
-</code>+
  
-==== Frontend ==== +===== 13. New Features of OpenEMM 21.10 (major changes) ===== 
-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. +  * E-8643: introduction of new quota system for usage of RESTful API 
-<code> +  * E-8525: improved usability for definition of default values in import profile 
-$ cd frontend +  * E-8420: list of datasource IDs sortable by description 
-$ ant -f build.xml +  * E-8384: show warning if date-based mailings uses several target groups combined with OR instead of AND 
-</code> +  * E-8327: improve deletion of mailing lists (show helpful warningsbut permit deletion in more cases than before) 
-We have built the binaries with Linux distribution CentOS 7. We are preparing separate wiki page with instructions on how to build OpenEMM 2019 with Linux distribution Suse 15.+  * E-8319: new WS method to retrieve mailing info based on a range of send dates 
 +  * E-8286: optional cleanup for recipients being inactive for 6, 12 or 24 months (data minimization/GDPR) 
 +  * E-8270: new RESTful method to generate webview URL for mailing 
 +  * E-8269: new RESTful method to list mailings received by a certain recipient 
 +  * E-8238: CToken as replacement for CI in web form URLs to hinder form spamming 
 +  * E-8211: Warning at leaving a mailing, when target group has been changed but mailing is not saved 
 +  * E-8207: improve definition of customized gender values in import profile 
 +  * E-8146: introduction of new quota system for webservices usage 
 +  * E-7885: option to bulk unsubscribe recipient from selected or all mailing lists 
 +  * E-7262: If another user is editing mailing, show his/her name in warning message 
 +  * E-6613: allow to mark target groups as favourites and show them first in lists 
 +  * E-5899: consider also duplicate email addresses when setting recipient to status “bounced” 
 +  * S-2187: optional cleanup after 7, 14 or 30 days of profile fields and tracking data for recipients who have unsubscribed from all lists (data minimization/GDPR) 
 +  * S-2116: new RESTful method to dispatch mailing 
 +  * L-0669: also show used mailing list in info popup that is shown before dispatch of a mailing 
 + 
 +===== Imprint ===== 
 +OpenEMM Wiki is a service of AGNITAS AG: https://www.agnitas.de/en/imprint/
start.1578162792.txt.gz · Last modified: 2020/01/04 18:33 by ma