Magnolia 4.5 reached end of life on June 30, 2016. This branch is no longer supported, see End-of-life policy.

Page tree
Skip to end of metadata
Go to start of metadata

This is a list of modules for Magnolia. 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 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.

Free modules

Free modules are available free of charge. You don't need an Enterprise license. You can run them with either Community Edition or Enterprise Edition. Most free modules are professionally supported by Magnolia International or its partners. You need a license to get support, however. Download free modules from Magnolia Store.

Installing a module

(warning) 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 and change configuration and may change content. Try new modules in a test environment first. A module consist of a JAR file and may include dependent JAR files. Modules are responsible for updating their own content and configuration across versions. Be sure to keep only one version of each module and its dependencies.

To install a module:

  1. Stop the application server.
  2. Copy the module JAR files into the WEB-INF/lib directory. The location of this directory depends on the application server.
    • Tomcat: /webapps/magnoliaAuthor/WEB-INF/lib
    • JBoss: /server/default/deploy/magnoliaPublic/WEB-INF/lib
  3. Restart the server.
  4. Go to the AdminCentral URL.
  5. Start the Web update process.
  6. Click Start up Magnolia.

Repeat the steps for each author and public instance.

Uninstalling a module

To uninstall a module, remove the module JAR file from the /WEB-INF/lib folder and restart Magnolia.

(warning) However, this is rarely enough. Modules add and modify configuration during installation. The use of a module also changes content. Removing all of these changes is difficult without knowing the installation tasks in detail. To test a module, use the embedded Derby database and take a backup of your repositories folder. Install the module and try it. 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. We also recommend that you segregate the development and production environments. Take regular backups for disaster recovery so you can revert to a prior state in a routine fashion.

  • No labels