A Magnolia module can be purely file based or it can be wrapped in a Maven project.
|Magnolia module wrapped in a typical Maven module |
structure before it is built.
|File-based Magnolia module under $magnolia.resources.dir|
magnolia.resources.diris a property defining the directory from which resources are loaded in a Magnolia instance. This directory is used for file-based resources such as light modules and for overriding classpath resources. The property is configured in
WEB-INF/config/default/magnolia.propertiesand has the default value
$magnolia.home/modules. To see the current value of the property, go to the Config Info tab in the About Magnolia app.
You can use symbolic links (a.k.a symlinks or soft links) in the resources directory to include light modules located elsewhere on your system.
<module-name>folder contains exactly the same content in a Maven module and folder-based module. In a Maven module this folder is within
src/main/resources. In a folder-based modules this folder is within
When creating a name for a module, do not use spaces, accented characters such as
üor special characters such as slashes
\and so on. The name must match the regular expression
create-light-module command in the Magnolia CLI creates the module folder structure on the file system automatically.
Configuration data for apps (YAML files)
Definition decorator files (YAML files)
Dialogs (YAML files), may have subfolders
FieldType definitions (YAML files).
i18n message bundle (.properties files).
MessageView definitions (YAML files).
All the web resources, typically contains subfolders. (Folder name is arbitrary.)
Template definitions (YAML files) and scripts with subfolders
Folder-based module in $magnolia.resources.dir
Starting with Magnolia 5.4, a Magnolia module does not have to be a Maven module. You can add a file-based module in the
$magnolia.resources.dir is the webapp folder, for instance
magnoliaPublic. See Add the module folder to $magnolia.home for more information about
Creating a light module with Magnolia CLI
Using the Magnolia CLI you can create the folder structure for a light module with the command
create-light-module. Open a shell,
cd to your light modules directory, and execute the following command:
üor special characters (e.g. slashes
\and so on). The name must match the regular expression
Note that this only works if you have installed Magnolia CLI, see Magnolia CLI Installation.
Magnolia Maven module
If you are familiar with Java and Maven you may want to use Maven to create and build your Magnolia module. Using Maven eases the process of creating a JAR file, deployment, and dependency management of your modules. All modules provided by Magnolia are built with Maven. This makes it easy to install or uninstall them by adding or removing a JAR file.
Creating a Magnolia Maven module with Maven archetypes
Magnolia provides a Maven archetype to build the skeleton of a Magnolia Maven module. The archetype provides options to build different modules:
- Basic Magnolia module
- Theme module
- Magnolia module to be hosted on the Magnolia Forge
- Magnolia module using Blossom
- Magnolia project (a parent pom and a webapp))
The archetypeCatalog is in
To choose an archetype:
- Create a directory on your local file system where the project will be stored and change into this directory.
Execute the following maven command:
Choose an archetype when prompted. Here we choose the option
magnolia-module-archetypewhich is a simple Magnolia project wrapped into Maven structure.
Next, the script asks to choose the archetype version - we recommend to choose always the latest version.
Now you must prompt typical Maven properties such as groupId, artifactId, package name and version plus the Magnolia specific parameters magnolia-bundle-version, module-class-name and module-name.
When you have prompted all the parameters - the archetype summarizes your inputs and you must confirm or can skip.
If you confirm, Maven generates the archetype skeleton.