Upgrading to Magnolia 6.1.x

This page contains the information you should be aware of when you are upgrading to Magnolia 6.1 from any previous and currently supported version. Upgrading from earlier versions to Magnolia 6.1 is a straightforward process. Before starting the upgrade process, we recommend you read:

• Release notes for the version you are updating to as well as for all intermediate versions.
• Certified stack

If you are migrating from Magnolia 4.4/4.5, please contact us for migration support. 

What to update

Hello DX Core, farewell Enterprise Editions

 With the release of Magnolia 6.1, product packaging has changed. DX Core is a new edition that replaces the former Enterprise Standard and Enterprise Pro editions.

This repackaging is reflected not only in the structure of our preconfigured bundles and webapps, but also in the values for Maven groupId and artifactId elements.

For an overview of the new product packaging approach, see the Product packaging section of Magnolia 6.1 release notes.

Magnolia UI 6.1

Compared to Magnolia 5.7, Magnolia UI 6.1 contains the new design of the admin interface. See Changes in Magnolia UI 6.1 for an overview.

If you follow the How to update steps below on this page, the UI project is also updated automatically.

If you have custom modules that rely on UI modules of version 5.7:

• Already built .jar files of your custom modules are binary compatible with Magnolia 6.0, you can add them to your WEB-INF/libs folder without further changes.
• If you want to compile and rebuild your custom modules:
  The composition of submodules of the UI project has changed, some submodules have been removed. But we have created Maven relocations for the removed modules; you do not have to change the dependencies to removed modules within your custom modules.

Check the magnolia.properties file

When upgrading Magnolia, it is always worth comparing your magnolia.properties file with the one from the newly released Magnolia bundles. Below are the latest versions of the magnolia.properties files for the Magnolia 6.1 series.

Magnolia CE

Apache Tomcat

Version 9.0.10

If you use Apache Tomcat, note that we have upgraded to Apache Tomcat 9.0.10. We recommend this update since it fixes some possible security vulnerabilities.

If you use another servlet container, check the certified stack for supported versions.

Server configuration with relaxed query chars

Tomcat 9 has become less tolerant of special characters when compared to some of its predecessor versions. To bring back support for special characters as it was on Tomcat 8 - for instance, to query the Delivery endpoint API with filters - we have added the characters [, ], and | to the relaxedQueryChars attribute on the Connector element in the server.xml configuration file. 

Third-party libraries

All changes in third-party libraries are managed via the BOM for third-party modules . If you manage your bundles via Maven using the BOM, all updates are handled automatically. Among the most notable third-party library updates in the Magnolia 6.1 release are:

• Vaadin 8.8.2
• Guava 27.1
• Tika 1.20
• Jackrabbit 2.18.1
• Ehcache 3.7.1
  Note: Due to an incompatibility issue, the items that are persisted on disk will be deleted after updating.

How to upgrade

Recommendations

• You should be able to upgrade to the latest release in the 6.1 branch of Magnolia directly from any previous Magnolia release that has not reached End-of-Life. Only if you have UI or style customizations, we recommend that you first update to the latest release in the Magnolia 5 branch and then to the latest release in the Magnolia 6 branch. For example: 5.6.8 → 5.7.30 → 6.1.

• Update all external libraries required by the Magnolia release to which you intend to upgrade.
• Because the upgrade process takes time and is vulnerable to incidents, we recommend you minimize the risk by cleaning up your system, removing unused data, reindexing everything and doing a full backup first.

Licensing

To obtain the license, get in touch with the contact person assigned to you in your contract or contact us directly via info@magnolia-cms.com. See also the License page for more information.

Upgrading manually

1. Stop the application server.
2. Extract the new Magnolia bundle.
3. Replace JAR files in the WEB-INF/lib folder of your old Magnolia instances with new JARs from the bundle. Also replace modules coming from the add-ons bundle (magnolia-enterprise-addons-bundle), in case you are using any of these.
   Magnolia 6.1 updates numerous 3rd-party libraries, see Third-party libraries.
4. Remove any module JARs you had previously removed from your instances. Add any modules you may have previously added.
5. Add new Magnolia modules.
6. Optional: Delete all indexes to give them a boost. Delete the index folder under each workspace directory: repositories/magnolia/workspaces/<workspace>/index. Indexes are recreated on startup, which might take a while depending on the size of your repository.
7. If you customized your magnolia.properties files, compare the changes to the file in the new bundle. Properties may have been added or removed.
8. Read the release notes for all intermediate versions for any additional update tasks. See the Releases page.
9. Restart the application server.
10. In your browser, go to the Magnolia instances and run the web update.

Upgrading Maven-managed webapps

In this section, we assume that you use Maven to manage your (custom) webapp. How you do this depends on how you have organized your pom files.

Upgrading the versions of inherited BOM files

The most typical use case is that your custom webapp is based on one of Magnolia's preconfigured webapps. The structure of the Maven project that manages your webapp may look like this:

custom-project/
├── custom-project-webapp
│   ├── pom.xml
│   └── src
└── pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <parent>
    <groupId>com.example</groupId>
    <artifactId>custom-project</artifactId>
    <version>1.0-SNAPSHOT</version>
    <relativePath>../pom.xml</relativePath>
  </parent>
  <artifactId>custom-project-webapp</artifactId>
  <name>custom-magnolia: webapp</name>
  <packaging>war</packaging>

  <dependencies>
    <dependency>
      <groupId>info.magnolia.dx</groupId>
      <artifactId>magnolia-dx-core-webapp</artifactId>
      <type>war</type>
    </dependency>
    <dependency>
      <groupId>info.magnolia.dx</groupId>
      <artifactId>magnolia-dx-core-webapp</artifactId>
      <type>pom</type>
    </dependency>
    <!-- More custom modules here -->
    <dependency>
      <groupId>com.example</groupId>
      <artifactId>foobar-module</artifactId>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <artifactId>maven-war-plugin</artifactId>
        <configuration>
          <!-- exclude jars copied "physically" from the webapp overlay - so we only get those resolved by Maven's dependency management -->
          <dependentWarExcludes>WEB-INF/lib/*.jar</dependentWarExcludes>
        </configuration>
      </plugin>
    </plugins>
  </build>
</project>

Line 5: custom-project/pom.xml is the parent pom file of your custom webapp. This file manages the dependencies and their versions. 

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.example</groupId>
  <artifactId>custom-project</artifactId>
  <name>custom-magnolia (parent pom)</name>
  <version>1.0-SNAPSHOT</version>
  <packaging>pom</packaging>

  <properties>
    <magnoliaBundleVersion>6.1</magnoliaBundleVersion>
    <foobarModuleVersion>1.2</foobarModuleVersion>
    <javaVersion>1.8</javaVersion>
  </properties>

  <scm>
    <connection/>
    <developerConnection/>
    <url/>
  </scm>

  <dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>info.magnolia.dx</groupId>
        <artifactId>magnolia-dx-core-parent</artifactId>
        <version>${magnoliaBundleVersion}</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
      <!-- More dependencies for your custom modules here -->
      <dependency>
        <groupId>com.example</groupId>
        <artifactId>foobar-module</artifactId>
        <version>${foobarModuleVersion}</version>
      </dependency>
    </dependencies>
  </dependencyManagement>


  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <version>3.7.0</version>
        <configuration>
          <source>${javaVersion}</source>
          <target>${javaVersion}</target>
        </configuration>
      </plugin>
    </plugins>

    <!-- default resources configuration which will filter your module descriptors -->
    <resources>
      <resource>
        <directory>src/main/resources</directory>
        <includes>
          <include>**/*</include>
        </includes>
      </resource>
      <resource>
        <filtering>true</filtering>
        <directory>src/main/resources</directory>
        <includes>
          <include>META-INF/magnolia/*</include>
        </includes>
      </resource>
    </resources>
  </build>

  <repositories>
    <repository>
      <id>magnolia.public</id>
      <url>https://nexus.magnolia-cms.com/content/groups/public</url>
      <snapshots>
        <enabled>false</enabled>
      </snapshots>
    </repository>
    <repository>
      <id>magnolia.enterprise.releases</id>
      <url>https://nexus.magnolia-cms.com/content/repositories/magnolia.enterprise.releases</url>
      <snapshots>
        <enabled>false</enabled>
      </snapshots>
    </repository>
    <repository>
      <id>vaadin-addons</id>
      <url>https://maven.vaadin.com/vaadin-addons</url>
    </repository>
  </repositories>

  <modules>
    <module>custom-project-webapp</module>
  </modules>
</project>

Note that the parent pom (custom-project/pom.xml) manages all versions for Magnolia modules as well as for third-party libraries.

It imports info.magnolia.dx:magnolia-dx-core-parent, which manages Magnolia Enterprise module versions and imports the following:

• info.magnolia.bundle:magnolia-bundle-parent – manages Magnolia CE module versions.
• info.magnolia.boms:magnolia-external-dependencies – manages third-party library versions.

If the pom files for your custom webapp are organized as shown in this example, you only need to change one property. In the <properties> section of your parent pom, change the version of the magnoliaBundleVersion property:

<properties>
  <magnoliaBundleVersion>6.1</magnoliaBundleVersion>
  <foobarModuleVersion>1.2</foobarModuleVersion>
  <javaVersion>1.8</javaVersion>
</properties>

Checking the Maven dependency tree

Regardless of how your Maven project is organized, building the Maven dependency tree helps you analyze the versions of all the Magnolia modules and all the third-party libraries of your custom webapp.

Open a shell, go to the directory of your webapp and execute the Maven command for the dependency tree:

cd /Users/jdoe/dev/repo/custom-mgnl-webapps/custom-project/custom-project-webapp
mvn dependency:tree

Other aspects

Use the !content-type directive

In app descriptors, if you refer to content type definitions, use the !content-type directive. For example:

!content-type:tourGuide
name: tourGuides-app

This should be of concern to you if you are upgrading from Magnolia 6.0 or 5.7.2+, where the directive was !with-type:

!with-type:tourGuide
name: tourGuides-app

Known issues

See the Known issues page.