Versions Compared

Old Version 49

changes.mady.by.user Christoph Meier

Saved on

compared with

New Version 50

changes.mady.by.user Christoph Meier

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
HTML Wrap
clearboth
width275px
alignright
classmenu

Related topics:

This page contains the information you should be aware of when upgrading to Magnolia 5.7.x from any previous and currently supported version, see the End-of-Life policy.

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 also check the Certified stack page. If migrating from Magnolia 4.4/4.5, please read migration documentation first. You can also contact us for migration support. 

Table of Contents
maxLevel4
minLevel2

What to update

Anchor
adding-privacy-modules
adding-privacy-modules
Adding new Magnolia 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).

Expand
titleClick here to expand to see how to install the privacy modules

Multiexcerpt include
MultiExcerptNameinstallation
PageWithExcerptPrivacy module

Anchor
anc-outdated-addons
anc-outdated-addons
Removing outdated add-on modules 

With Magnolia 5.7 we have removed a few modules which ere not bundled but added as add-ons. We recommend to remove them. 

Here is the list of the removed add-on modules:

  • magnolia-jndi-1.0.2
  • magnolia-module-newsletter-bundle-2.2
  • magnolia-module-webdav-2.1.3
  • magnolia-templating-samples-5.4.1

See also 

Jira
serverMagnolia - Issue tracker
columnskey,summary,type,created,updated,due,assignee,reporter,priority,status,resolution
serverId500b06a6-e204-3125-b989-2d75b973d05f
keyMGNLEE-533
.

Webdav

Note

You must remove the magnolia-module-webdav - since Jackrabbit 2.16 is not supporting webdav anymore.

Tomcat 9.0.8

If you are using Tomcat: We moved to Tomcat 9.0.8.

3rd-party libraries

Jackrabbit 2.16.1

If you want to run Magnolia on Java 8 or 9, you must use Jackrabbit 2.16.1.

  • 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

If you come from Magnolia 5.5.x or even lower, please read the instructions to upgrade to Magnolia 5.6.x concerning custom modules and the widget set too.

  • 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

How to 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 → 

    Artifact resource link
    rangeHigherVersion5.6
    groupIdinfo.magnolia.bundle
    artifactIdmagnolia-bundle-parent
    label$version
    renderTypedisplay_only
    resourceTypePOM
     → 
    Artifact resource link
    rangeHigherVersion5.7
    groupIdinfo.magnolia.bundle
    artifactIdmagnolia-bundle-parent
    label$version
    renderTypedisplay_only
    resourceTypePOM
     → 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.

Updating 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.
    (warning) Note that Magnolia 5.7 updates numerous 3rd-party libraries - see Java 8, 9 and 10 runtime compatibility and library updates.
  4. Remove any module JARs you had previously removed from your instances. Add any modules you might have added.
    (warning) Note that we have removed a few modules from the add-ons. Some of them you must remove. See Removing outdated add-on modules.
  5. Add new introduced modules - see Adding the privacy modules.
  6. 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.
  7. If you customized magnolia.properties files, compare the changes to the file in the new bundle. Properties may have been added and removed.
  8. Read release notes for all intermediary versions for any additional update tasks.
  9. Restart the application server.
  10. Using your browser, go to the Magnolia instances and run the Web update.

Updating Maven managed webapps

...

The magnolia.properties file

Todo
  • Remove the SNAPSHOT version on the artifact macro displaying the latest 5.7.x version
  • fetch the proper version of the properties files based on the latest tagged version after the release.
Tip

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

(info) Between Magnolia 5.6.6 and Magnolia 5.7 - the magnolia.properties file has not changed.

Below find the latest versions of  the magnolia.properties files of the Magnolia 5.7 series: 

Artifact resource link
groupIdinfo.magnolia.bundle
artifactIdmagnolia-bundle-parent
label$version
renderTypedisplay_only
versionSNAPSHOT
resourceTypePOM

Magnolia CE / Magnolia EE Standard*

Code Pro
profilebitbucket-ee
languagetext
titlece/magnolia-empty-webapp/src/main/webapp/WEB-INF/config/default/magnolia.properties
collapsetrue
urlhttps://git.magnolia-cms.com/projects/PLATFORM/repos/ce/raw/magnolia-empty-webapp/src/main/webapp/WEB-INF/config/default/magnolia.properties?at=master
*) Magnolia CE and Magnolia EE Standard are using the same magnolia.properties file.
Magnolia EE Pro
 Code Pro
profilebitbucket-ee
languagetext
titleee/magnolia-enterprise-pro-webapp/src/main/webapp/WEB-INF/config/default/magnolia.properties
collapsetrue
urlhttps://git.magnolia-cms.com/projects/PLATFORM/repos/ee/raw/magnolia-enterprise-pro-webapp/src/main/webapp/WEB-INF/config/default/magnolia.properties?at=master
xxx
Tomcat 9.0.8
We moved to Tomcat 9.0.8.
Jackrabbit 2.16.1
If you want to run Magnolia on Java 8 or 9, you must use Jackrabbit 2.16.1.
  • 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
If you come from Magnolia 5.5.x or even lower, please read the instructions to upgrade to Magnolia 5.6.x concerning custom modules and the widget set too.
  • 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
 Anchor
anc-known-issues
anc-known-issues
Known issues
If you encounter problems, please check the Known issues page first.