Upgrading to Magnolia 5.7.x

Before starting the upgrade, please read the release notes for the version you are updating to and all intermediate versions, the general upgrade procedure and the specific aspects. If migrating from Magnolia 4.4/4.5, please read migration documentation first. You can also contact us for migration support. 

General procedure

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.
4. Remove any module JARs you had previously removed from your instances. Add any modules you might have added.
5. Add new introduced modules - see Adding the privacy modules.
6. Replace 3rd-party libraries which have been updated - see Java 8, 9 and 10 runtime compatibility and library updates.
7. Optional: Delete all indexes to give them a little 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.
8. If you customized magnolia.properties files, compare the changes to the file in the new bundle. Properties may have been added and removed.
9. Read release notes for all intermediary versions for any additional update tasks.
10. Restart the application server.
11. Using your browser, go to the Magnolia instances and run the Web update.

Recommendations

1. Update to your latest minor release version first before upgrade to recent major release. A June 2018 example: a customer is considering an upgrade from 5.5.8 to 5.7. The correct sequence would be: 5.5.8 → 

   Error rendering macro 'artifact-resource-macro'

   com.sun.jersey.api.client.ClientHandlerException: java.net.NoRouteToHostException: No route to host (Host unreachable)

    → 

   Error rendering macro 'artifact-resource-macro'

   com.sun.jersey.api.client.ClientHandlerException: java.net.NoRouteToHostException: No route to host (Host unreachable)

    → 5.7

2. Update all external libraries required by the Magnolia release to which you intend to upgrade.
3. Carefully look for "change" or "changes for ..." sections in the release notes since.
4. Because the upgrade process takes time and is vulnerable to incidents, please minimize the risk by cleaning up your system, removing unused data, reindexing everything and doing a full backup first.

The magnolia.properties file

When upgrading Magnolia - its is always worth to compare your magnolia.properties file with the one coming from freshly released Magnolia bundles. 

Here are the latest versions:

Magnolia CE:

..

Magnolia EE Standard:

..

Magnolia EE Pro:

..

Adding new modules - the privacy modules

If you have an Enterprise license - add the new Privacy modules which helps you to adapt your websites compliant with the General Data Protection Regulation (GDPR).

<dependency>
  <groupId>info.magnolia.privacy</groupId>
  <artifactId>magnolia-privacy-cookie-manager</artifactId>
</dependency>

<dependency>
  <groupId>info.magnolia.privacy</groupId>
  <artifactId>magnolia-privacy-visitor-manager</artifactId>
</dependency>

<dependency>
  <groupId>info.magnolia.privacy</groupId>
  <artifactId>magnolia-privacy-ui</artifactId>
</dependency>

<dependency>
  <groupId>info.magnolia.privacy</groupId>
  <artifactId>magnolia-privacy-sample</artifactId>
</dependency>

Removing outdated modules - remove WebDAV

...

Java 8, 9 and 10 runtime compatibility and library updates

Magnolia 5.7 can be run on Java 8, 9 or 10. The minimum Java version required stays at 8. We also took the opportunity to numerous 3rd-party libraries. 

You should you replace all the 3rd-party libraries listed below. We list the new version which you should add.

Tomcat 9.0.8

We moved to Tomcat 9.0.8.

Jackrabbit 2.16

• jackrabbit-api-2.16.1
• jackrabbit-core-2.16.1
• jackrabbit-data-2.16.1
• jackrabbit-jcr-commons-2.16.1
• jackrabbit-spi-2.16.1
• jackrabbit-spi-commons-2.16.1

Vaadin 8.4.2

• vaadin-compatibility-aceeditor-1.0
• vaadin-compatibility-ckeditor-1.0
• vaadin-compatibility-client-8.4.2
• vaadin-compatibility-context-menu-1.0
• vaadin-compatibility-expandingtextarea-1.0
• vaadin-compatibility-server-8.4.2
• vaadin-compatibility-shared-8.4.2
• vaadin-compatibility-themes-8.4.2
• vaadin-compatibility-tokenfield-1.0
• vaadin-server-8.4.2
• vaadin-shared-8.4.2
• validation-api-1.1.0.Final 

Other 3rd-party libraries

• commons-lang3-3.7
• freemarker-2.3.25-incubating
• groovy-all-2.4.3
• gson-2.2.2
• guice-4.2.0
• guice-multibindings-4.2.0
• jackson-databind-2.9.5
• jsoup-1.8.3
• mycila-guice-closeable-4.0
• mycila-guice-injection-4.0
• mycila-guice-jsr-4.0
• snakeyaml-1.21
• xercesImpl-2.12

Known issues

Other issues

For other known issues please see the Known issues page.

Further reading

• ...