Modules list
A module is an independent Magnolia CMS component. Magnolia CMS itself is actually built as a collection of different modules. For example, the AdminCentral itself is a module.
If you want to extend Magnolia CMS with your own functionality, we recommend that you create a custom module. You will not have to start from scratch. There are some prepared abstract classes which can be used to create a new module. It's common practice to implement and extend one or more of these prepared abstract module classes.
Enterprise modules
Enterprise modules require an enterprise license to run. Download Enterprise modules from Magnolia Store.
| Module | Description | Price | Support |
|---|---|---|---|
| Advanced Cache | Advanced caching and flushing strategies. | Part of EE | Supported with EE |
| Backup | Ensures proper backup of data from inside of Magnolia. | Part of EE | Supported with EE |
| Content dependencies | The content dependencies module provides functionality to track what content is referred to by web pages and dms assets (e.g. images, documents). | Part of EE | Supported with EE |
| Content translation support | Enables transport (e.g. export/import) of i18n content from/to Magnolia in order to be able to create or update translations based on files (xls, csv). Simplifies data-exchange with external units like translation departments or companies. | Part of EE | Supported with EE |
| Diff | Provides visual diff functionality for Magnolia content, thus allowing editors to compare text and image changes between multiple versions of content. | Part of EE | Supported with EE |
| Extended Templating Kit (ETK) | ETK provides various additional functionalities compared to STK, e.g. multi-site support, an imaging backend, or categorization | Part of EE | Supported with EE |
| LDAP | Provides LDAP authentication | Part of EE | Supported with EE |
| Newsletter | Provides an API to connect to newsletter services like MailChimp or CampaignMonitor. | Part of EE | Supported with EE |
| NTLM Connector | Single sign-on functionality for Windows systems within a trusted domain environment. | Part of EE | Supported with EE |
| Packager | The Packager allows to create packages that can include anything from within Magnolia or on the filesystem. | Part of EE | Supported with EE |
| Soft locking | Provides soft locking capabilities to Magnolia. Soft locking differs from JCR hard locking in that it does not really lock the node being edited, rather it just stores information about who is locking a certain content, so that this information can be shown as a warning (e.g. to users concurrently editing the same page). | Part of EE | Supported with EE |
| Synchronization | Used to synchronize a target instance with a source instance | Part of EE | Supported with EE |
| Tools | Tools for manipulating repository content | Part of EE | Supported with EE |
| Transactional Activation | Ensures synchronization of content between multiple public instances during publishing | Part of EE | Supported with EE |
| WebLogic compatibility | Provides compatibility with WebLogic | Part of EE | Supported with EE |
| WebSphere compatibility | Provides compatibility with WebSphere | Part of EE | Supported with EE |
Free modules
Free modules are available free of charge. You don't need an Enterprise license to run them. Most free modules are professionally supported by Magnolia International or its partners. You need a license to access support. Download free modules from Magnolia Store.
| Module | Description | Price | Support |
|---|---|---|---|
| BDB | Berkeley DB persistence manager for Jackrabbit. | Free | Not supported |
| Blossom | Magnolia Blossom is the Spring integration module for Magnolia. It lets you write reusable paragraphs and templates with a high level of dynamic behaviour that editors can compose to create truly interactive web pages. | Free | Supported with EE |
| BootstrapSync | This is module will allow you to automatically export to filesystem your changes in magnolia repositories. | Free | Commercial support available from Openmind. |
| Controls | Additional advanced controls for Magnolia | Free | Commercial support available from Openmind. |
| Criteria API | Easily query your Magnolia/JCR repository in plain Java | Free | Commercial support available from Openmind. |
| CRX Connector | Use Content Repository Extreme (CRX) as a data source. | Free | Not supported. |
| Data | Manage structured data, e.g. addresses, categories, products etc. | Free | Supported with EE |
| Developer samples | Template examples that show how to write custom templates from scratch in Freemarker and JSP | Free | Supported with EE |
| DMS | Document Management System | Free | Supported with EE |
| Form | Magnolia Form module provides a way of creating your own forms, with validation, log and mail functionalities. This module is available in Magnolia 4.0 and higher. | Free | Supported with EE |
| Forum | Have forums in your Magnolia sites | Free | Supported with EE |
| Frisbee | The Frisbee module was developed as a "bag" of STK paragraphs with one common factor: social. | ||
| Google Analytics for STK | Enables Google Analytics within STK projects | Free | Supported with EE |
| Google Map | Templates and paragraphs to manage and display google maps - supports point of interest as well as vertices | Free | |
| Google Sitemap | This module lets you generate and configure Google site maps from Magnolia. | Free | Supported with EE |
| Groovy Interactive Shell & Scripting Support | Groovy Interactive Console and Magnolia scripting support | Free | Supported with EE |
| Groovy shell | Run groovy scripts in Magnolia | Free | Commercial support available from Openmind. |
| In-place Templating | Allows editing templates from within Magnolia | Free | Supported with EE |
| In-place Templating (JSP Support) | Allows editing JSP templates from within Magnolia | Free | |
| JNDI | Java Naming and Directory Interface (JNDI) allows Magnolia CMS JCR repository to be exposed outside of Magnolia web application. | Free | Supported with EE |
| Migrator | Migrate content from Magnolia CMS 2.1 to 3.0. | Free | Supported with EE |
| Messages | Translate messages directly from the Magnolia admin interface. | Free | Commercial support available from Openmind. |
| Observation | Allows configuring observation listeners, executing e.g commands | Free | Supported with EE |
| Public User Registration | The Public User Registration Module (PUR) provides self-service functionality to register members on your website. | Free | Supported with EE |
| Repository Tools | Check and repair your Jackrabbit repository from the Magnolia admin interface. | Free | Commercial support available from Openmind. |
| Resources | Manage and edit resource files (CSS, Javascript) from withing Magnolia | Free | Supported with EE |
| RSS Aggregator | Allows to aggregate, display and produce various RSS/Atom feeds. | Free | Supported with EE |
| Scheduler | Allows configuring scheduled jobs and commands in Magnolia | Free | Supported with EE |
| SimpleMedia | SimpleMedia is a module for Magnolia CMS that allows a centralized management of all medias (images, YouTube movies, flvs, mp3s) to be used in your site. | Free | Commercial support available from Openmind. |
| Standard Templating Kit | The STK is a complete, out-of-the-box website layout that conforms to accessibility standards. It provides "templating best practice" and an extensive set of ready-made functionality that can easily be extended for custom designs and content output. Licensed under GPL v3. | Free | Supported with EE |
| Stripes | Integrates the Stripes MVC framework into a Magnolia-based website | Free | Commercial support available from Openmind. |
| Struts | Integrates the Struts 1.1 framework into a Magnolia-based website | Free | Commercial support available from Openmind. |
| Tag cloud | The easy way to build tag clouds with Magnolia CMS | Free | Commercial support available from Openmind. |
| Tasks | A collection of Magnolia update tasks that can be reused in custom modules | Free | Commercial support available from Openmind. |
| Translation Helper | Free | Supported with EE | |
| Utils | A collection of generic Magnolia utilities, mainly tags and EL functions | Free | Commercial support available from Openmind. |
| WebDAV | Allows editing templates, resources and script via WebDAV | Free | Supported with EE |
| Wiki Syntax Rendering | Allows editing content with a Wiki-like syntax. | Free | Supported with EE |
| Workflow | Magnolia workflow module based on OpenWFE. Part of the standard distribution. | Free | Supported with EE |
Community modules
Community modules are available for use with the Community Edition. Download the module JAR from Magnolia's Nexus repository.
| Name | Latest version | Dependencies | Download | Source |
|---|---|---|---|---|
| Cache | 4.4.5 | Magnolia 4.4.5 Exchange Simple 4.4.1 | JAR bundled with CE and EE | Subversion |
| Categorization | 1.1.7 | Magnolia 4.2 AdminInterface 4.2 Data 1.4 RSS Aggregator 1.0.2 STK 1.2 | JAR | Subversion |
| Commenting | 1.1.4 | Magnolia 4.2.1 Forum 1.1 Cache 4.2.1 Observation 1.1 | JAR | Subversion |
| Data | 1.6.4 | Magnolia 4.4 Workflow 4.4 Scheduler 1.4.2 Cache 4.4 | JAR bundled with EE | Subversion |
| DMS | 1.5.2 | Magnolia 4.4 FCKEditor 4.4 Cache 4.4 | JAR bundled with CE and EE | Subversion |
| Excel renderer | 1.0 SNAPSHOT | AdminInterface 3.5 Templating 3.5 DMS 1.2 | JAR | Subversion |
| Exchange Simple | 4.4.5 | Magnolia 4.4.5 | JAR bundled with CE and EE | Subversion |
| FCKEditor | 4.4.5 | AdminInterface 4.4.5 | JAR bundled with CE and EE | Subversion |
| Form | 1.2.4 | Magnolia 4.4 | JAR bundled with EE and STK | Subversion |
| Forum | 1.2.1 | Magnolia 4.2.3+ | JAR bundled with EE | Subversion |
| Imaging | 2.1 | Magnolia 4.4 AdminInterface 4.4 | JAR bundled with STK | Subversion |
| Inplace Templating | 1.2.1 | Magnolia 4.3 Templating 4.3 Cache 4.3 | JAR bundled with EE and STK | Subversion |
| 4.4.5 | AdminInterface 4.4.5 | JAR bundled with CE and EE | Subversion | |
| Observation | 1.2 | Magnolia 4.0+ | JAR | Subversion |
| Poll | 1.0 SNAPSHOT | Magnolia 3.5+ | JAR | Subversion |
| Public user registration | 1.3.1 | AdminInterface 4.4.2 Mail 4.4.2 Form 1.2 | JAR bundled with EE and STK | Subversion |
| Resources | 1.4 | Magnolia 4.4 Cache 4.4 FCKEditor 4.4 | JAR bundled with EE and STK | Subversion |
| RSS Aggregator | 1.2.1 | Magnolia 4.4 Observation 1.1 Data 1.3.2 Java 5+ | JAR | Subversion |
| Samples | 4.4.5 | AdminInterface 4.4.5 | JAR in the add-ons folder | Subversion |
| Scheduler | 1.4.2 | AdminInterface 4.3 | JAR bundled with EE and STK | Subversion |
| Shell | 1.0 SNAPSHOT | Magnolia 3.6+ | JAR | Subversion |
| Standard Templating Kit | 1.4.5 | Magnolia 4.4.5 AdminInterface 4.4.5 Cache 4.4 FCKEditor 4.4.5 Resources 1.4 In-place Templating 1.2 DMS 1.5.2 Data 1.6.4 RSS Aggregator 1.2.1 Public User Registration 1.3.1 | JAR bundled with EE | Subversion |
| Templating | 4.4.5 | Magnolia 4.4.5 | JAR bundled with CE and EE | Subversion |
| Todo list | 1.1.1 | AdminInterface 4.1 | JAR | Subversion |
| WebDAV | 1.0.1 | Magnolia 4.2 Cache 4.2 | JAR | Subversion |
| Wiki rendering | 1.1.7 | Magnolia 4.3.3 Templating 4.3.3 Snippet 1.0.1 | JAR | Subversion |
| Workflow | 4.4.5 | Magnolia 4.4.5 | JAR bundled with EE | Subversion |
Installing
Backup!
Take a backup of your system before you install a module. Uninstalling a module is not as simple as removing the .jar file. Modules add new configuration nodes, modify existing configuration and may change content. We recommend trying out new modules in a test environment first.
A module consist of a JAR file and potentially other dependencies as JAR files. Modules are responsible for updating their own content and configuration across versions. Be sure to keep one single version of each module and its dependencies.
- Stop the application server where you deploy the module.
- Copy the JAR file(s) into
WEB-INF/libdirectory inside your webapp. Location of this directory depends on the application server. - Tomcat:
/webapps/magnoliaAuthor/WEB-INF/lib - JBoss:
/server/default/deploy/magnoliaPublic/WEB-INF/lib - Restart the instance.
- Access the AdminCentral interface.
Magnolia CMS update wizard will start. - Click the link to start the update process.
The update wizard installs the JAR file and reports results. - Click Start up Magnolia.
- Magnolia CMS restarts.
Uninstalling
Uninstalling a module involves removing the module JAR from /WEB-INF/lib folder and restarting Magnolia. However, this is rarely enough as modules add new configuration nodes and modify existing configuration during their installation. The use of a module also results in changes to content repositories. Removing all of this information is difficult without knowing exactly what the installation tasks were.
repositories folder. Then install the module and try it out. When you are done testing, remove the module JAR and restore the repositories folder from the backup. This way you can go back to square one after the trial. We also recommend that you implement segregated development and production environments and take regular backups for disaster recovery so you can revert to a prior state in a routine fashion.