Magnolia 6.1 reached end of life on March 31, 2021. This branch is no longer supported, see End-of-life policy.
Back up your system before installing a module. Uninstalling a module is not always as simple as removing the file. Modules can add and change configuration in the repository. They may also change content. You should try the module in a test environment first. A module is responsible for updating itself across versions. Keep only one version of each module and its dependencies.
Choose this option if the module is delivered as a folder or a ZIP file. This type of module is configured completely on the file system.
Magnolia scans the directory periodically and registers the module. It also detects new and modified templates, dialogs and resources.
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 its default value is
$magnolia.home/modules. To see the current value of the property, go to the Config Info tab in the About Magnolia app.
magnolia.resources.filesystem.observation.excludedDirectories property to exclude directories from being observed for changes. (See Configuration management - magnolia.resources.filesystem.observation.excludedDirectories.)
Choose this option if you have your own bundle. Using Maven to manage module dependencies is a best practice.
dependency element including the module version number in your bundle's parent POM:
<project> <dependencyManagement> <dependencies> <dependency> <groupId><!-- groupId --></groupId> <artifactId><!-- artifactId --></artifactId> <version><!-- version --></version> </dependency> </dependencies> </dependencyManagement> </project>
dependency element without the version number in the Magnolia webapp POM, typically inside the parent project:
<project> <dependencies> <dependency> <groupId><!-- groupId --></groupId> <artifactId><!-- artifactId --></artifactId> </dependency> </dependencies> </project>
We strongly discourage using this option. Instead, we recommend you set up a Maven project and let it manage dependencies as described above.
Choose this option if the module is delivered as a JAR file. All modules provided by Magnolia are JAR files.