Modules

Magnolia has a modular architecture. A module can perform a task, package content, or provide specialized functionality. Modules can be project specific or reused across different projects. You should use the module mechanism to package and deploy your own site’s configuration and functionality.

In Magnolia documentation, the terms module and project module always refer to a Magnolia module.

What makes a Magnolia module are files specific to Magnolia in a particular folder. You can add such a Magnolia module folder directly into the webapp of your Magnolia instance.

You can define a Magnolia module with one file, with its Module descriptor. Typically, the descriptor resides either in a Maven module or within a light module together with other files.

When you are creating a website project, you should have one module for templates, another module for content, a third for a theme, and so on.

  • Maven module

  • Light module

Maven also uses the term module but it means something different. For this, we explicitly write Maven module. You can make the Magnolia module folder part of a Maven module. In that case you would build a JAR file and deploy it to your webapp.

You don’t need to know Java or Maven to create a perfectly valid Magnolia module. Put your project files into a file-system directory to create a light module.

This enables light development, a development style which does not require Java skills or a Java development environment. It’s a straightforward way to get started with Magnolia development and works well for front-end developers. The Hello Magnolia tutorial uses light development to create a fully-functional template module.

Store your light modules outside of the apache-tomcat directory so that the modules you add can be accessed by any Magnolia instance. If you already have a light modules directory you want to use, edit the magnolia.resources.dir property in your magnolia.properties file to point to it.

Module types

Some modules are bundled as part of the standard Core offering. This means the module is automatically installed as part of your project.

All other modules are unbundled. For these modules, you can pick and choose the modules you want to add to your project. Note that additional licenses may be required.

Type Description

Core

Core Magnolia modules

These modules comprise the foundation of Magnolia and its functionality.

Requires standard license and is bundled as part of that license.

This includes Community Edition (CE) modules which are free and open-source.

Extension

Extension modules

These modules extend the functionality of Magnolia and meet certain use-cases.

May require an additional license and typically, the module is unbundled. This means there is likely additional installation required.

See individual modules for details.

Framework

Framework modules

These modules provide frameworks to use extensions.

May require an additional license and typically, the module is unbundled. This means there is likely additional installation required.

See individual modules for details.

Incubator

Incubator modules

These modules are provided by Magnolia Professional Services. They are offered in incubator mode and are supported by Magnolia Professional Services on commercially reasonable efforts only, meaning Magnolia is not bound to fix any bug or issue right away.

Included in standard DX Core core license and the module is unbundled. This means there is likely additional installation required.

See individual modules for details.

List of modules

Module Type Bundled License Latest

About App module

Core

CE

6.3.0

A/B/n Testing

Extension

Special

2.0.1

Admincentral module

Core

CE

6.3.5

Adobe Marketo extension

Extension

Special

2.0.1

Adyen Connector module

Incubator

DX Core

1.0

Advanced cache modules

Core

DX Core

3.0.1

Algolia search index feeder

Incubator

DX Core

1.0.1

Algolia E-commerce connector

Incubator

DX Core

1.0.2

Analytics integration framework

Framework

DX Core

2.0.0

Adobe analytics extension

Extension

Special

2.0.0

Google analytics extension

Extension

Special

2.0.0

Matomo analytics extension

Extension

Special

2.0.0

AWS S3 extension

Extension

Special

2.2.3

Backup module

Extension

DX Core

2.5.1

Blossom module

Extension

CE

4.0.0

BSI CDP extension

Extension

Special

1.0

Bynder extension

Extension

Special

2.2.3

Cache modules

Core

CE

6.0.4

Campaign importer module

Incubator

DX Core

3.1.14

Campaign manager module

Extension

DX Core

3.1.14

Campaign Publisher

Extension

DX Core

4.0.1

CAS module

Extension

DX Core

1.3.2

Categorization module

Core

CE

3.0.1

CDN Helper module

Incubator

DX Core

1.0.6

CDP integration framework

Framework

DX Core

1.0

Celum DAM Connector module

Incubator

DX Core

1.0.5

Cloudinary External DAM module

Extension

Special

1.2.2

Commenting module

Incubator

DX Core

1.1.4

Commerce integration framework

Framework

DX Core

2.0.3

Commerce Adobe extension

Extension

Special

1.3.6

Commerce commercetools extension

Extension

Special

1.3.6

Commerce Salesforce extension

Extension

Special

1.3.6

Commerce SAP extension

Extension

Special

1.3.6

Configuration Framework module

Core

CE

6.3.10

Contacts module Deprecated

Extension

CE

2.0.0

Content Dependencies module

Core

DX Core

3.0.0

Content Editor module

Core

DX Core

3.0.3

Content Importer module

Core

CE

2.0.0

Content Tags module

Core

DX Core

3.0.0

Content Translation Support module

Extension

DX Core

3.0.0

Content Types module

Core

CE

2.0.1

Content Translation Extended module

Framework

DX Core

4.2.0

CTSX DeepL Translator

Extension

DX Core

4.2.0

CTSX Google Translator

Incubator

DX Core

4.2.0

CTSX Microsoft Translator

Incubator

DX Core

4.2.0

CTSX AT Language Solutions

Incubator

DX Core

4.2.0

CTSX Instant Translation

Incubator

DX Core

4.2.0

CTSX Transperfect

Incubator

DX Core

4.2.0

Definitions App module

Core

CE

3.0.4

Device Detection module

Extension

CE

1.1

Diff module

Core

DX Core

3.0.1

Digital Asset Management module

Core

CE

4.0.8

Elasticsearch Index Feeder

Incubator

DX Core

1.0.1

External DAM integration framework

Framework

DX Core

2.2.3

Form module

Extension

CE

3.0.0

Frontify DAM connector

Incubator

DX Core

2.0.0

GraphQL module

Extension

DX Core

2.1.0

Groovy module

Extension

CE

4.0.0

High performance caching modules

Extension

DX Core

multiple (see modules)

Hooks API module

Incubator

DX Core

1.0.0

Image Focal module

Incubator

DX Core

3.0.4

Image Recognition

Extension

DX Core

2.0.2

Imaging module

Core

CE

4.1.0

Javascript Models

Core

CE

3.0.0

JavaScript UI module

Extension

DX Core

2.1.0

JCR Tools module

Core

CE

2.0.0

LDAP Connector module

Extension

DX Core

2.0.0

Live Copy module

Extension

Special

4.1.0

Log Tools module

Core

CE

2.0.0

Mail module

Extension

CE

6.0.0

Marketing automation integration framework

Framework

DX Core

2.0.1

Marketing Tags module

Core

DX Core

3.0.2

Messages App module

Core

CE

6.3.0

Microsoft DAM Connector module

Incubator

DX Core

1.0

mParticle CDP extension

Extension

Special

1.0

MTK module

Extension

CE

3.0.2

MTE module

Extension

CE

3.0.2

Multisite module

Core

DX Core

3.0.0

Observation module

Extension

CE

3.0.0

AI Accelerator module

Extension

Special

1.1.3

Pages module

Core

CE

6.3.6

Password Manager module

Extension

CE

2.0.0

Periscope module

Framework

CE

2.0.1

Personalization module

Core

DX Core

3.0.5

Privacy module

Extension

DX Core

2.0.0

Public User Registration module

Extension

CE

3.0.0

Publishing module

Core

CE

2.0.4

Publishing Transactional module

Core

DX Core

2.0.2

Resources module

Core

CE

4.0.4

REST Client module

Core

CE

3.0.3

REST module

Framework

CE

3.1.1

REST Proxy module

Framework

DX Core

2.0.0

Salesforce Sales Cloud extension

Extension

Special

2.0.1

RSS Aggregator module

Core

CE

2.6.6

Scheduler module

Core

CE

3.0.0

Security app module

Core

CE

3.0.0

Segment CDP extension

Extension

Special

1.0

SEO module

Incubator

DX Core

6.2.2

Siteimprove module

Extension

Special

1.2.1

Slack Integration module

Incubator

DX Core

1.2

Site module

Core

CE

2.0.2

Soft Locking module

Core

DX Core

4.0.0

Solr module

Extension

DX Core

9.0.0

Solr search index feeder

Incubator

DX Core

1.0.1

SSO module

Extension

DX Core

4.0.2

Synchronization module

Extension

DX Core

3.0.0

Task Email Notifications module

Incubator

DX Core

6.2

Text Classification module

Extension

DX Core

2.0.0

Tools module

Core

DX Core

2.0.0

User Result Ranker module

Core

DX Core

2.0.0

UI Framework REST Extensions module

Core

DX Core

2.0.0

UI module

Core

CE

6.3.10

UI Media Editor module

Core

CE

6.3.10

Virtual URI module

Core

CE

6.3.10

Webhooks module

Core

DX Core

2.0.2

WeChat Login module

Incubator

DX Core

1.0

Workflow module

Core

DX Core

7.0.4
Feedback

DX Core

×

Location

This widget lets you know where you are on the docs site.

You are currently perusing through the DX Core docs.

Main doc sections

DX Core Headless PaaS Legacy Cloud Incubator modules