====== OpenEMM Installation & Configuration Wiki ====== Latest version of **OpenEMM 25.04 BETA**: 25.04.000.**068**\\ Latest version of **OpenEMM 24.10**: 24.10.000.**175**\\ Latest version of **OpenEMM 24.04**: 24.04.000.**102**\\ Latest version of **OpenEMM 23.10**: 23.10.000.**236**\\ Latest version of **OpenEMM 23.04**: 23.04.000.**231**\\ Latest version of **OpenEMM 22.10**: 22.10.000.**230**\\ Latest version of **OpenEMM 22.04**: 22.04.000.**238**\\ Latest version of **OpenEMM 21.10**: 21.10.000.**108**\\ (as of April 25, 2024)\\ \\ **OpenEMM is a web based enterprise application for email and marketing automation. It is used for automated email communication with customers, leads, members and employees. It can be operated via a browser interface with great usability, or in headless mode via its SOAP or REST API. 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:** **Brief introduction of OpenEMM (English):** **New Version 25.04 of OpenEMM (German):** **New Features of OpenEMM 24.04, Installation and Upgrades (English):** **Upgrade Opportunities (OpenEMM Plus, English):** **Features of OpenEMM and new Features of OpenEMM 23.10 (German):** **Installation and Updates (German):** **Commercial Support Services and OpenEMM Plus (German):** 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. * **Factsheet OpenEMM 25.04 (EN): {{ :agnitas-openemm-news-version-25.04-en.pdf |Factsheet for OpenEMM 25.04}}** * **Factsheet OpenEMM 25.04 (DE): {{ :agnitas-openemm-neuerungen-version-25.04-de.pdf |Factsheet für OpenEMM 25.04}}** * **Factsheet OpenEMM 24.10 (EN): {{ :openemm_24.10_factsheet_en.pdf |Factsheet for OpenEMM 24.10}}** * **Factsheet OpenEMM 24.10 (DE): {{ :openemm_24.10_factsheet_de.pdf |Factsheet für OpenEMM 24.10}}** * **Factsheet OpenEMM 24.04 (EN): {{ :agnitas-openemm-neuerungen-version-24.04-en.pdf |Factsheet for OpenEMM 24.04}}** * **Factsheet OpenEMM 24.04 (DE): {{ :agnitas-openemm-neuerungen-version-24.04-de.pdf |Factsheet für OpenEMM 24.04}}** * Javascript Widget to generate Subscribe Forms (EN + DE): {{ :emm-subscribe-toolbox.zip |Javascript Widget Toolbox}} The guide to installation and administration of OpenEMM can be found here: * OpenEMM 25.04: {{ ::openemm_25.04_install_admin_guide_1.0.0.pdf|OpenEMM 25.04 Installation & Administration Guide 1.0.0}} * OpenEMM 24.10: {{ ::openemm_24.10_install_admin_guide_1.0.2.pdf|OpenEMM 24.10 Installation & Administration Guide 1.0.2}} * OpenEMM 24.04: {{ ::openemm_24.04_install_admin_guide_1.0.1.pdf|OpenEMM 24.04 Installation & Administration Guide 1.0.1}} * OpenEMM 23.10: {{ ::openemm_23.10_install_admin_guide_1.0.5.pdf|OpenEMM 23.10 Installation & Administration Guide 1.0.5}} * OpenEMM 23.04: {{ ::openemm_23.04_install_admin_guide_1.0.2.pdf|OpenEMM 23.04 Installation & Administration Guide 1.0.2}} * OpenEMM 22.10: {{ ::openemm_22.10_install_admin_guide_1.0.1.pdf|OpenEMM 22.10 Installation & Administration Guide 1.0.1}} * OpenEMM 22.04: {{ ::openemm_22.04_install_admin_guide_1.0.0.pdf|OpenEMM 22.04 Installation & Administration Guide 1.0.0}} * OpenEMM 21.10: {{ ::openemm_21.10_install_admin_guide_1.0.6.pdf|OpenEMM 21.10 Installation & Administration Guide 1.0.6}} We also offer an [[virtualbox|OVA version]] for OpenEMM 24.04: https://share.agnitas.de/index.php/s/qbC9Kx4G785t55n/download (see section [[virtualbox|OpenEMM on VirtualBox]] for details) We kindly ask you to contribute feedback for OpenEMM! Please leave any bug findingy, questions and comments in the **OpenEMM Support Forum** at https://forum.openemm.org . This helps us to improve the code, installation, configuration, administration and documentation of OpenEMM.\\ \\ If you want to stay on top of things, please subscribe to the OpenEMM newsletter at the end of page\\ https://www.agnitas.de/en/e-marketing_manager/email-marketing-software-variants/openemm/ (English)\\ or\\ https://www.agnitas.de/e-marketing-manager/email-marketing-software/openemm/ (German)\\ and follow our X account at https://x.com/openemm .\\ \\ If you are interested in more **OpenEMM Support & Service Offers**, please visit website\\ https://www.agnitas.de/en/e-marketing_manager/email-marketing-software-variants/openemm/openemm-support-services/ \\ ==== More resources: ==== Here is a video with first steps: * https://youtu.be/WBnkq1pzprY (English) * https://youtu.be/9iw81WGoXWE (German) 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. ---- ===== 1. Introduction ===== OpenEMM is a professional open source software for email marketing and automation with a state-of-the-art user interface. For even more automation of your email communication and integration with other IT systems, you may use the REST or SOAP API of OpenEMM to operate it in headless mode.\\ Any way you want to use it, 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. ---- ===== 2. Basic Requirements ===== * RedHat 7 to 9; AlmaLinux 8 or 9; SLES 15 * with VirtualBox: Windows, macOS or any other Linux -> see section [[virtualbox|OpenEMM on VirtualBox]] for details * Java Open JDK 11 or 17 **(OpenEMM > 24.10.000.121 requires Java 17!)** * Apache Tomcat 10.1 (including NIO Connector for HTTPS support) * Python 3.8 or later * DBMS: MariaDB 10.5 or 10.6 * MTA: Postfix 2.6 or later ---- ===== 3. Mailing Templates and Forms ===== 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".** If your forms are attacked by click bots, you should implement a honeypot form field to fight off those click bots. Here is an explanation how this could be done: * Quickguide Honeypot (EN): {{ :emm-quickguide_honeypot_1.1.pdf | Quickguide}} * Kurzanleitung Honeypot (DE): {{ :emm-kurzanleitung_honeypot_1.1.pdf | Kurzanleitung}} ---- ===== 4. Updates ===== The top of this Wiki lists the latest available versions of OpenEMM code and the deployment & runtime package. You can download the latest versions of packages with menu "Install or update package from AGNITAS Website" of OMT (OpenEMM Maintenance Tool). An update of the code will also update the schema of the OpenEMM database, if necessary. If you do not use the latest version of OpenEMM, OMT offers you to upgrade to a new release. 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). ---- ===== 5. Administration ===== See the Installation & Administration Guides linked at the top of this document for extensive information on administration of OpenEMM. ---- ===== 6. Known Issues in 25.04 ===== ==== 6.1 Open Issues ==== * no open issues ==== 6.2 Fixed Issues ==== * no fixed issues ---- ===== 7. Building OpenEMM yourself ===== Download the source code of OpenEMM from GitHub at https://github.com/agnitas-org/openemm to a directory of your choice. ==== Backend ==== $ git clone https://github.com/agnitas-org/openemm $ cd openemm/backend $ chmod 755 build-backend.py $ ./build-backend.py ==== Frontend ==== 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. $ cd openemm/frontend $ ant -f build.xml ---- ===== Imprint ===== OpenEMM Wiki is a service of AGNITAS AG: https://www.agnitas.de/en/imprint/