Modules list
This is a list of modules for Magnolia CMS. A module is an independent component that performs a particular task or is used to package content and functionality. The system itself is built of modules; AdminCentral, Document Management System and Workflow are all modules.
If you want to extend Magnolia CMS with your own functionality, we recommend that you create a custom module. You do not need 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 Edition license. You can download these modules from Magnolia Store.
| Module | Description | Price | Support |
|---|---|---|---|
| Advanced Cache | A collection of advanced cache strategies that minimize server load and simultaneously ensure that fresh content is served. | Part of EE | Supported with EE |
| Backup | Backs up data from inside Magnolia CMS as an alternative to file system and database backup solutions. | Part of EE | Supported with EE |
| Content dependencies | Track content that web pages depend on, including other pages and DMS assets such as images and documents. | Part of EE | Supported with EE |
| Content translation support | Export and import page content in translation-friendly CSV and Excel formats. | Part of EE | Supported with EE |
| Diff | Allows editors and reviewers to compare differences between two versions of a page using the redlining feature. | Part of EE | Supported with EE |
| Extended Templating Kit (ETK) | Extends the functionality of Standard Templating Kit with multi-site support, an imaging engine and categorization support. | 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 CampaignMonitor. | Part of EE | Supported with EE |
| NTLM Connector | Provides single sign-on (SSO) functionality for Windows systems within a trusted domain environment. | Part of EE | Supported with EE |
| Packager | Create packages of content and configuration that can be backed up and restored. | Part of EE | Supported with EE |
| Soft locking | Provides concurrent editing capabilities by flashing a series of alerts that warn editors about other activity on the page. | Part of EE | Supported with EE |
| Synchronization | Synchronize target and source instances by activating only previously activated content. | 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 activation. | 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 Edition license to run them. Most free modules are professionally supported by Magnolia International or its partners. You need a license to access support, however. Download free modules from Magnolia Store.
| Module | Description | Price | Support |
|---|---|---|---|
| BDB | Berkeley DB persistence manager for Jackrabbit. | Free | Not supported |
| Blossom | Provides Spring integration for Magnolia. This facilitates coding of reusable paragraphs and templates that allow editors to create truly dynamic and interactive pages. | Free | Supported with EE |
| BootstrapSync | Export changes to Magnolia repositories (workspaces) to the file system automatically. | Free | Commercial support available from Openmind. |
| Controls | Additional advanced controls for Magnolia CMS. | Free | Commercial support available from Openmind. |
| Criteria API | Provides a simple alternative to standard Magnolia CMS query APIs by facilitating queries of 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 such as contacts, products, categories and RSS feeds for retrieval and use on web pages. | Free | Supported with EE |
| DMS | Manage documents in Magnolia AdminCentral. | Free | Supported with EE |
| Form | Magnolia Form module provides a way of creating your own forms, with validation, log and mail Create your own forms with multi-step, field validation, automated logging and email sending. | Free | Supported with EE |
| Forum | Add a discussion forum to your site and manage it in AdminCentral. | Free | Supported with EE |
| Frisbee | Provides a set of STK paragraphs designed for integration with all the popular social networking sites including Google Maps, Flickr, Facebook, Twitter, ShareThis and AddThis. | ||
| Google Analytics for STK | Integrate Magnolia CMS websites with Google Analytics. | Free | Supported with EE |
| Google Map | Templates and paragraphs to manage and display Google Maps. Supports points of interest and vertices. | Free | |
| Google Sitemap | Generate and configure XML Sitemaps of a Magnolia site. | Free | Supported with EE |
| Groovy Interactive Shell & Scripting Support | Adds Groovy capabilities to Magnolia and installs an interactive Groovy console in AdminCentral. | Free | Supported with EE |
| Groovy Shell | Run groovy scripts. | 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 | Expose Magnolia's JCR repository outside of the 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 | Configure observation listeners, for example to execute commands. | Free | Supported with EE |
| Public User Registration | Provides the functionality for users to register themselves on your website and is fully integrated with the Standard Templating Kit. | Free | Supported with EE |
| Repository Tools | Check and repair Jackrabbit repository from AdminCentral. | Free | Commercial support available from Openmind. |
| Resources | Manage and edit resource files (CSS, JavaScript) in AdminCentral. | Free | Supported with EE |
| RSS Aggregator | Display aggregated feeds on web pages and generate internal feeds based on Magnolia CMS content for syndication. | Free | Supported with EE |
| Scheduler | Schedule jobs and commands. | Free | Supported with EE |
| Shop | Adds shop functionality to Magnolia CMS without the need to install additional software components. | Free | Supported with EE |
| SimpleMedia | Centralized management of media files including images, YouTube movies, FLV, and MP3 used on 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 | Generate tag cloud components and manage the tags. | Free | Commercial support available from Openmind. |
| Tasks | Collection of update tasks that can be reused in custom modules. | Free | Commercial support available from Openmind. |
| Templating samples | Showcase of Magnolia CMS features for developers, including customizable examples of dialogs, page and paragraph templates, filters and servlets. | Free | Supported with EE |
| Translation Helper | Free | Supported with EE | |
| Utils | A collection of generic Magnolia utilities and extensions. | Free | Commercial support available from Openmind. |
| WebDAV | Includes a WebDAV interface that facilitates access to Magnolia repositories in order to create, edit and manage templates and resources on a Magnolia server. | Free | Supported with EE |
| Wiki Syntax Rendering | Allows editing content with a wiki-like syntax. | Free | Supported with EE |
| Workflow | Provides the functionality for editorial content workflow based on OpenWFE engine. | 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 | Git |
| Categorization | 1.1.7 | Magnolia 4.2 AdminInterface 4.2 Data 1.4 RSS Aggregator 1.0.2 STK 1.2 | JAR | Git |
| CMIS | 1.0 | Magnolia 4.5.1 DMS 1.6 | JAR | Git |
| Commenting | 1.1.4 | Magnolia 4.2.1 Forum 1.1 Cache 4.2.1 Observation 1.1 | JAR | Git |
| Data | 1.6.4 | Magnolia 4.4 Workflow 4.4 Scheduler 1.4.2 Cache 4.4 | JAR bundled with EE | Git |
| Device Detection | 1.0.1 | Magnolia 4.5.1 | JAR bundled with CE and EE | Git |
| DMS | 1.5.2 | Magnolia 4.4 FCKEditor 4.4 Cache 4.4 | JAR bundled with CE and EE | Git |
| Excel renderer | 1.0 SNAPSHOT | AdminInterface 3.5 Templating 3.5 DMS 1.2 | JAR | Git |
| Exchange Simple | 4.4.5 | Magnolia 4.4.5 | JAR bundled with CE and EE | Git |
| FCKEditor | 4.4.5 | AdminInterface 4.4.5 | JAR bundled with CE and EE | Git |
| Form | 1.2.4 | Magnolia 4.4 | JAR bundled with EE and STK | Git |
| Forum | 1.2.1 | Magnolia 4.2.3+ | JAR bundled with EE | Git |
| Imaging | 2.1 | Magnolia 4.4 AdminInterface 4.4 | JAR bundled with STK | Git |
| Inplace Templating | 1.2.1 | Magnolia 4.3 Templating 4.3 Cache 4.3 | JAR bundled with EE and STK | Git |
| 4.4.5 | AdminInterface 4.4.5 | JAR bundled with CE and EE | Git | |
| Observation | 1.2 | Magnolia 4.0+ | JAR | Git |
| Poll | 1.0 SNAPSHOT | Magnolia 3.5+ | JAR | Git |
| Public user registration | 1.3.1 | AdminInterface 4.4.2 Mail 4.4.2 Form 1.2 | JAR bundled with EE and STK | Git |
| Resources | 1.4 | Magnolia 4.4 Cache 4.4 FCKEditor 4.4 | JAR bundled with EE and STK | Git |
| RSS Aggregator | 1.2.1 | Magnolia 4.4 Observation 1.1 Data 1.3.2 Java 5+ | JAR | Git |
| Samples | 4.4.5 | AdminInterface 4.4.5 | JAR in the add-ons folder | Git |
| Scheduler | 1.4.2 | AdminInterface 4.3 | JAR bundled with EE and STK | Git |
| Templating | 4.4.5 | Magnolia 4.4.5 | JAR bundled with CE and EE | Git |
| Todo list | 1.1.1 | AdminInterface 4.1 | JAR | Git |
| WebDAV | 1.0.1 | Magnolia 4.2 Cache 4.2 | JAR | Git |
| 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 | Git |
Installing
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.