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

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

Back up your system before installing a module. Uninstalling is not as simple as removing the JAR files. Modules add and change configuration and may change content. 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.

Option 1: Maven dependencies

Choose this option if you have a bundle. Managing module dependencies with Maven is a Magnolia best practice.

To install a module:

  1. Add a dependency element including the module version number in the bundle parent POM:

    Bundle parent pom.xml
    <project>
      <dependencyManagement>
        <dependencies>
          <dependency>
            <groupId><!-- groupId --></groupId>
            <artifactId><!-- artifactId --></artifactId>
            <version><!-- version --></version>
          </dependency>
        </dependencies>
      </dependencyManagement>
    </project>
  2. Add a dependency element without the version number in the Magnolia webapp POM, typically inside the parent project:

    Webapp pom.xml
    <project>
      <dependencies>
        <dependency>
          <groupId><!-- groupId --></groupId>
          <artifactId><!-- artifactId --></artifactId>
        </dependency>
      </dependencies>
    </project>

Option 2: JAR files

Choose this option if you are new to Magnolia.

  1. Download the module JAR files from Magnolia's Nexus repository or from the third party that provides the module.
  2. Stop Magnolia.
  3. Copy the JAR files into the WEB-INF/lib directory.
    • Tomcat: /webapps/<contextPath>/WEB-INF/lib
    • JBoss: /server/default/deploy/<contextPath>/WEB-INF/lib
  4. Start Magnolia.
  5. Open a browser and go to Magnolia AdminCentral
  6. Run the Web update.